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,1465 @@
|
|
|
1
|
+
# (c) Copyright Ascensio System SIA 2026
|
|
2
|
+
#
|
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
# you may not use this file except in compliance with the License.
|
|
5
|
+
# You may obtain a copy of the License at
|
|
6
|
+
#
|
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
#
|
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
# See the License for the specific language governing permissions and
|
|
13
|
+
# limitations under the License.
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
require 'cgi'
|
|
17
|
+
|
|
18
|
+
module DocspaceApiSdk
|
|
19
|
+
module Files
|
|
20
|
+
class MetadataApi
|
|
21
|
+
attr_accessor :api_client
|
|
22
|
+
|
|
23
|
+
def initialize(api_client = ApiClient.default)
|
|
24
|
+
@api_client = api_client
|
|
25
|
+
end
|
|
26
|
+
# Assign templates to a file
|
|
27
|
+
# Assigns one or more metadata templates to a file, so its fields can be filled with `PUT api/2.0/files/metadata/file/{fileId}/values`. The caller needs the right to edit the file. The assignment writes no values and is idempotent: a template the file already carries is skipped, the others are added, an empty list changes nothing. The call finishes in the request, nothing runs in the background. A template a cascading folder above the file already provides stays inherited. A file the caller cannot edit is answered with 403; a file, or a template, that does not exist with 404. To take a template off the file use `DELETE api/2.0/files/metadata/file/{fileId}/templates/{templateId}`.
|
|
28
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/assign-file-templates/
|
|
29
|
+
# @param file_id [Integer] The file ID.
|
|
30
|
+
# @param assign_metadata_templates [AssignMetadataTemplates] The parameters for assigning templates.
|
|
31
|
+
# @param [Hash] opts the optional parameters
|
|
32
|
+
# @return [nil]
|
|
33
|
+
def assign_file_templates(file_id, assign_metadata_templates, opts = {})
|
|
34
|
+
assign_file_templates_with_http_info(file_id, assign_metadata_templates, opts)
|
|
35
|
+
nil
|
|
36
|
+
end
|
|
37
|
+
|
|
38
|
+
# Assign templates to a file
|
|
39
|
+
# Assigns one or more metadata templates to a file, so its fields can be filled with `PUT api/2.0/files/metadata/file/{fileId}/values`. The caller needs the right to edit the file. The assignment writes no values and is idempotent: a template the file already carries is skipped, the others are added, an empty list changes nothing. The call finishes in the request, nothing runs in the background. A template a cascading folder above the file already provides stays inherited. A file the caller cannot edit is answered with 403; a file, or a template, that does not exist with 404. To take a template off the file use `DELETE api/2.0/files/metadata/file/{fileId}/templates/{templateId}`.
|
|
40
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/assign-file-templates/
|
|
41
|
+
# @param file_id [Integer] The file ID.
|
|
42
|
+
# @param assign_metadata_templates [AssignMetadataTemplates] The parameters for assigning templates.
|
|
43
|
+
# @param [Hash] opts the optional parameters
|
|
44
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
45
|
+
def assign_file_templates_with_http_info(file_id, assign_metadata_templates, opts = {})
|
|
46
|
+
if @api_client.config.debugging
|
|
47
|
+
@api_client.config.logger.debug 'Calling API: Files::MetadataApi.assign_file_templates ...'
|
|
48
|
+
end
|
|
49
|
+
# verify the required parameter 'file_id' is set
|
|
50
|
+
if @api_client.config.client_side_validation && file_id.nil?
|
|
51
|
+
fail ArgumentError, "Missing the required parameter 'file_id' when calling Files::MetadataApi.assign_file_templates"
|
|
52
|
+
end
|
|
53
|
+
# verify the required parameter 'assign_metadata_templates' is set
|
|
54
|
+
if @api_client.config.client_side_validation && assign_metadata_templates.nil?
|
|
55
|
+
fail ArgumentError, "Missing the required parameter 'assign_metadata_templates' when calling Files::MetadataApi.assign_file_templates"
|
|
56
|
+
end
|
|
57
|
+
# resource path
|
|
58
|
+
local_var_path = '/api/2.0/files/metadata/file/{fileId}/templates'.sub('{' + 'fileId' + '}', CGI.escape(file_id.to_s))
|
|
59
|
+
|
|
60
|
+
# query parameters
|
|
61
|
+
query_params = opts[:query_params] || {}
|
|
62
|
+
|
|
63
|
+
# header parameters
|
|
64
|
+
header_params = opts[:header_params] || {}
|
|
65
|
+
# HTTP header 'Accept' (if needed)
|
|
66
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
67
|
+
# HTTP header 'Content-Type'
|
|
68
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
69
|
+
if !content_type.nil?
|
|
70
|
+
header_params['Content-Type'] = content_type
|
|
71
|
+
end
|
|
72
|
+
|
|
73
|
+
# form parameters
|
|
74
|
+
form_params = opts[:form_params] || {}
|
|
75
|
+
|
|
76
|
+
# http body (model)
|
|
77
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(assign_metadata_templates)
|
|
78
|
+
|
|
79
|
+
# return_type
|
|
80
|
+
return_type = opts[:debug_return_type]
|
|
81
|
+
|
|
82
|
+
# auth_names
|
|
83
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
84
|
+
|
|
85
|
+
new_options = opts.merge(
|
|
86
|
+
:operation => :"Files::MetadataApi.assign_file_templates",
|
|
87
|
+
:header_params => header_params,
|
|
88
|
+
:query_params => query_params,
|
|
89
|
+
:form_params => form_params,
|
|
90
|
+
:body => post_body,
|
|
91
|
+
:auth_names => auth_names,
|
|
92
|
+
:return_type => return_type
|
|
93
|
+
)
|
|
94
|
+
|
|
95
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
96
|
+
if @api_client.config.debugging
|
|
97
|
+
@api_client.config.logger.debug "API called: Files::MetadataApi#assign_file_templates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
98
|
+
end
|
|
99
|
+
return data, status_code, headers
|
|
100
|
+
end
|
|
101
|
+
|
|
102
|
+
# Assign templates to a folder
|
|
103
|
+
# Assigns one or more metadata templates to a folder or a room and, with `cascade` set, propagates them to every folder and file below it. The caller needs the right to create in the folder (a room manager or a content creator); for a room that is its manager. The assignment itself finishes in the request and writes no values. The cascade is asynchronous: a pass is queued that assigns the templates to the whole subtree and copies the values the folder holds, and the answer is that pass with the `templateIds` it propagates. Poll `GET api/2.0/files/metadata/folder/{folderId}/templates/progress` until `isCompleted` is true; a failed pass reports its `error` there. The `conflictResolveType` decides what happens to a value an entry already holds: `Skip` keeps it, `Overwrite` replaces it with the folder's value. A folder inside the subtree that cascades the same template keeps its own values for its content. Without a cascade the answer is a completed operation without an identifier; a template that already cascades keeps cascading, it is turned off with `PUT api/2.0/files/metadata/folder/{folderId}/templates/{templateId}`. A caller without the right to create in the folder is answered with 403; a folder, or a template, that does not exist with 404.
|
|
104
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/assign-folder-templates/
|
|
105
|
+
# @param folder_id [Integer] The folder ID.
|
|
106
|
+
# @param assign_metadata_templates [AssignMetadataTemplates] The parameters for assigning templates.
|
|
107
|
+
# @param [Hash] opts the optional parameters
|
|
108
|
+
# @return [MetadataOperationWrapper]
|
|
109
|
+
def assign_folder_templates(folder_id, assign_metadata_templates, opts = {})
|
|
110
|
+
data, _status_code, _headers = assign_folder_templates_with_http_info(folder_id, assign_metadata_templates, opts)
|
|
111
|
+
data
|
|
112
|
+
end
|
|
113
|
+
|
|
114
|
+
# Assign templates to a folder
|
|
115
|
+
# Assigns one or more metadata templates to a folder or a room and, with `cascade` set, propagates them to every folder and file below it. The caller needs the right to create in the folder (a room manager or a content creator); for a room that is its manager. The assignment itself finishes in the request and writes no values. The cascade is asynchronous: a pass is queued that assigns the templates to the whole subtree and copies the values the folder holds, and the answer is that pass with the `templateIds` it propagates. Poll `GET api/2.0/files/metadata/folder/{folderId}/templates/progress` until `isCompleted` is true; a failed pass reports its `error` there. The `conflictResolveType` decides what happens to a value an entry already holds: `Skip` keeps it, `Overwrite` replaces it with the folder's value. A folder inside the subtree that cascades the same template keeps its own values for its content. Without a cascade the answer is a completed operation without an identifier; a template that already cascades keeps cascading, it is turned off with `PUT api/2.0/files/metadata/folder/{folderId}/templates/{templateId}`. A caller without the right to create in the folder is answered with 403; a folder, or a template, that does not exist with 404.
|
|
116
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/assign-folder-templates/
|
|
117
|
+
# @param folder_id [Integer] The folder ID.
|
|
118
|
+
# @param assign_metadata_templates [AssignMetadataTemplates] The parameters for assigning templates.
|
|
119
|
+
# @param [Hash] opts the optional parameters
|
|
120
|
+
# @return [Array<(MetadataOperationWrapper, Integer, Hash)>] MetadataOperationWrapper data, response status code and response headers
|
|
121
|
+
def assign_folder_templates_with_http_info(folder_id, assign_metadata_templates, opts = {})
|
|
122
|
+
if @api_client.config.debugging
|
|
123
|
+
@api_client.config.logger.debug 'Calling API: Files::MetadataApi.assign_folder_templates ...'
|
|
124
|
+
end
|
|
125
|
+
# verify the required parameter 'folder_id' is set
|
|
126
|
+
if @api_client.config.client_side_validation && folder_id.nil?
|
|
127
|
+
fail ArgumentError, "Missing the required parameter 'folder_id' when calling Files::MetadataApi.assign_folder_templates"
|
|
128
|
+
end
|
|
129
|
+
# verify the required parameter 'assign_metadata_templates' is set
|
|
130
|
+
if @api_client.config.client_side_validation && assign_metadata_templates.nil?
|
|
131
|
+
fail ArgumentError, "Missing the required parameter 'assign_metadata_templates' when calling Files::MetadataApi.assign_folder_templates"
|
|
132
|
+
end
|
|
133
|
+
# resource path
|
|
134
|
+
local_var_path = '/api/2.0/files/metadata/folder/{folderId}/templates'.sub('{' + 'folderId' + '}', CGI.escape(folder_id.to_s))
|
|
135
|
+
|
|
136
|
+
# query parameters
|
|
137
|
+
query_params = opts[:query_params] || {}
|
|
138
|
+
|
|
139
|
+
# header parameters
|
|
140
|
+
header_params = opts[:header_params] || {}
|
|
141
|
+
# HTTP header 'Accept' (if needed)
|
|
142
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
143
|
+
# HTTP header 'Content-Type'
|
|
144
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
145
|
+
if !content_type.nil?
|
|
146
|
+
header_params['Content-Type'] = content_type
|
|
147
|
+
end
|
|
148
|
+
|
|
149
|
+
# form parameters
|
|
150
|
+
form_params = opts[:form_params] || {}
|
|
151
|
+
|
|
152
|
+
# http body (model)
|
|
153
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(assign_metadata_templates)
|
|
154
|
+
|
|
155
|
+
# return_type
|
|
156
|
+
return_type = opts[:debug_return_type] || 'MetadataOperationWrapper'
|
|
157
|
+
|
|
158
|
+
# auth_names
|
|
159
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
160
|
+
|
|
161
|
+
new_options = opts.merge(
|
|
162
|
+
:operation => :"Files::MetadataApi.assign_folder_templates",
|
|
163
|
+
:header_params => header_params,
|
|
164
|
+
:query_params => query_params,
|
|
165
|
+
:form_params => form_params,
|
|
166
|
+
:body => post_body,
|
|
167
|
+
:auth_names => auth_names,
|
|
168
|
+
:return_type => return_type
|
|
169
|
+
)
|
|
170
|
+
|
|
171
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
172
|
+
if @api_client.config.debugging
|
|
173
|
+
@api_client.config.logger.debug "API called: Files::MetadataApi#assign_folder_templates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
174
|
+
end
|
|
175
|
+
return data, status_code, headers
|
|
176
|
+
end
|
|
177
|
+
|
|
178
|
+
# Add a metadata field
|
|
179
|
+
# Adds a field to an existing metadata template. Only a DocSpace admin can change templates. The field name must be unique within the template regardless of case and at most 255 characters, the type must be one of the published ones, a choice field needs at least one option and unique option values, a field of another type takes no options. A field without `order` is placed after the last field of the template. The entries the template is already assigned to get the field without a value: nothing is written on them and no cascade runs. The answer is the created field with its generated option identifiers. A template that does not exist is answered with 404, an invalid field with 400.
|
|
180
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/create-field/
|
|
181
|
+
# @param template_id [Integer] The template ID.
|
|
182
|
+
# @param metadata_field_request [MetadataFieldRequest] The parameters of the field.
|
|
183
|
+
# @param [Hash] opts the optional parameters
|
|
184
|
+
# @return [MetadataFieldWrapper]
|
|
185
|
+
def create_field(template_id, metadata_field_request, opts = {})
|
|
186
|
+
data, _status_code, _headers = create_field_with_http_info(template_id, metadata_field_request, opts)
|
|
187
|
+
data
|
|
188
|
+
end
|
|
189
|
+
|
|
190
|
+
# Add a metadata field
|
|
191
|
+
# Adds a field to an existing metadata template. Only a DocSpace admin can change templates. The field name must be unique within the template regardless of case and at most 255 characters, the type must be one of the published ones, a choice field needs at least one option and unique option values, a field of another type takes no options. A field without `order` is placed after the last field of the template. The entries the template is already assigned to get the field without a value: nothing is written on them and no cascade runs. The answer is the created field with its generated option identifiers. A template that does not exist is answered with 404, an invalid field with 400.
|
|
192
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/create-field/
|
|
193
|
+
# @param template_id [Integer] The template ID.
|
|
194
|
+
# @param metadata_field_request [MetadataFieldRequest] The parameters of the field.
|
|
195
|
+
# @param [Hash] opts the optional parameters
|
|
196
|
+
# @return [Array<(MetadataFieldWrapper, Integer, Hash)>] MetadataFieldWrapper data, response status code and response headers
|
|
197
|
+
def create_field_with_http_info(template_id, metadata_field_request, opts = {})
|
|
198
|
+
if @api_client.config.debugging
|
|
199
|
+
@api_client.config.logger.debug 'Calling API: Files::MetadataApi.create_field ...'
|
|
200
|
+
end
|
|
201
|
+
# verify the required parameter 'template_id' is set
|
|
202
|
+
if @api_client.config.client_side_validation && template_id.nil?
|
|
203
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling Files::MetadataApi.create_field"
|
|
204
|
+
end
|
|
205
|
+
# verify the required parameter 'metadata_field_request' is set
|
|
206
|
+
if @api_client.config.client_side_validation && metadata_field_request.nil?
|
|
207
|
+
fail ArgumentError, "Missing the required parameter 'metadata_field_request' when calling Files::MetadataApi.create_field"
|
|
208
|
+
end
|
|
209
|
+
# resource path
|
|
210
|
+
local_var_path = '/api/2.0/files/metadata/templates/{templateId}/fields'.sub('{' + 'templateId' + '}', CGI.escape(template_id.to_s))
|
|
211
|
+
|
|
212
|
+
# query parameters
|
|
213
|
+
query_params = opts[:query_params] || {}
|
|
214
|
+
|
|
215
|
+
# header parameters
|
|
216
|
+
header_params = opts[:header_params] || {}
|
|
217
|
+
# HTTP header 'Accept' (if needed)
|
|
218
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
219
|
+
# HTTP header 'Content-Type'
|
|
220
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
221
|
+
if !content_type.nil?
|
|
222
|
+
header_params['Content-Type'] = content_type
|
|
223
|
+
end
|
|
224
|
+
|
|
225
|
+
# form parameters
|
|
226
|
+
form_params = opts[:form_params] || {}
|
|
227
|
+
|
|
228
|
+
# http body (model)
|
|
229
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(metadata_field_request)
|
|
230
|
+
|
|
231
|
+
# return_type
|
|
232
|
+
return_type = opts[:debug_return_type] || 'MetadataFieldWrapper'
|
|
233
|
+
|
|
234
|
+
# auth_names
|
|
235
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
236
|
+
|
|
237
|
+
new_options = opts.merge(
|
|
238
|
+
:operation => :"Files::MetadataApi.create_field",
|
|
239
|
+
:header_params => header_params,
|
|
240
|
+
:query_params => query_params,
|
|
241
|
+
:form_params => form_params,
|
|
242
|
+
:body => post_body,
|
|
243
|
+
:auth_names => auth_names,
|
|
244
|
+
:return_type => return_type
|
|
245
|
+
)
|
|
246
|
+
|
|
247
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
248
|
+
if @api_client.config.debugging
|
|
249
|
+
@api_client.config.logger.debug "API called: Files::MetadataApi#create_field\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
250
|
+
end
|
|
251
|
+
return data, status_code, headers
|
|
252
|
+
end
|
|
253
|
+
|
|
254
|
+
# Create a metadata template
|
|
255
|
+
# Creates a metadata template for the whole portal, optionally with its fields in one call. Only a DocSpace admin can create templates. The template name must be unique on the portal regardless of case, at most 255 characters, and the name `System` is reserved. Every field needs a name unique within the template and a type from the published set; a choice field requires at least one option and the options must be unique, a field of another type takes no options. A field without `order` is placed after the fields that have one, in the order of the request. The template and its fields are stored together: an invalid field rejects the whole request and nothing is created. The answer is the created template with its fields and the generated option identifiers, which the values written with `PUT api/2.0/files/metadata/file/{fileId}/values` refer to. A name already in use or an invalid field is answered with 400; the request of a member who is not a DocSpace admin with 403.
|
|
256
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/create-template/
|
|
257
|
+
# @param [Hash] opts the optional parameters
|
|
258
|
+
# @option opts [CreateMetadataTemplateRequestDto] :create_metadata_template_request_dto
|
|
259
|
+
# @return [MetadataTemplateWrapper]
|
|
260
|
+
def create_template(opts = {})
|
|
261
|
+
data, _status_code, _headers = create_template_with_http_info(opts)
|
|
262
|
+
data
|
|
263
|
+
end
|
|
264
|
+
|
|
265
|
+
# Create a metadata template
|
|
266
|
+
# Creates a metadata template for the whole portal, optionally with its fields in one call. Only a DocSpace admin can create templates. The template name must be unique on the portal regardless of case, at most 255 characters, and the name `System` is reserved. Every field needs a name unique within the template and a type from the published set; a choice field requires at least one option and the options must be unique, a field of another type takes no options. A field without `order` is placed after the fields that have one, in the order of the request. The template and its fields are stored together: an invalid field rejects the whole request and nothing is created. The answer is the created template with its fields and the generated option identifiers, which the values written with `PUT api/2.0/files/metadata/file/{fileId}/values` refer to. A name already in use or an invalid field is answered with 400; the request of a member who is not a DocSpace admin with 403.
|
|
267
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/create-template/
|
|
268
|
+
# @param [Hash] opts the optional parameters
|
|
269
|
+
# @option opts [CreateMetadataTemplateRequestDto] :create_metadata_template_request_dto
|
|
270
|
+
# @return [Array<(MetadataTemplateWrapper, Integer, Hash)>] MetadataTemplateWrapper data, response status code and response headers
|
|
271
|
+
def create_template_with_http_info(opts = {})
|
|
272
|
+
if @api_client.config.debugging
|
|
273
|
+
@api_client.config.logger.debug 'Calling API: Files::MetadataApi.create_template ...'
|
|
274
|
+
end
|
|
275
|
+
# resource path
|
|
276
|
+
local_var_path = '/api/2.0/files/metadata/templates'
|
|
277
|
+
|
|
278
|
+
# query parameters
|
|
279
|
+
query_params = opts[:query_params] || {}
|
|
280
|
+
|
|
281
|
+
# header parameters
|
|
282
|
+
header_params = opts[:header_params] || {}
|
|
283
|
+
# HTTP header 'Accept' (if needed)
|
|
284
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
285
|
+
# HTTP header 'Content-Type'
|
|
286
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
287
|
+
if !content_type.nil?
|
|
288
|
+
header_params['Content-Type'] = content_type
|
|
289
|
+
end
|
|
290
|
+
|
|
291
|
+
# form parameters
|
|
292
|
+
form_params = opts[:form_params] || {}
|
|
293
|
+
|
|
294
|
+
# http body (model)
|
|
295
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'create_metadata_template_request_dto'])
|
|
296
|
+
|
|
297
|
+
# return_type
|
|
298
|
+
return_type = opts[:debug_return_type] || 'MetadataTemplateWrapper'
|
|
299
|
+
|
|
300
|
+
# auth_names
|
|
301
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
302
|
+
|
|
303
|
+
new_options = opts.merge(
|
|
304
|
+
:operation => :"Files::MetadataApi.create_template",
|
|
305
|
+
:header_params => header_params,
|
|
306
|
+
:query_params => query_params,
|
|
307
|
+
:form_params => form_params,
|
|
308
|
+
:body => post_body,
|
|
309
|
+
:auth_names => auth_names,
|
|
310
|
+
:return_type => return_type
|
|
311
|
+
)
|
|
312
|
+
|
|
313
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
314
|
+
if @api_client.config.debugging
|
|
315
|
+
@api_client.config.logger.debug "API called: Files::MetadataApi#create_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
316
|
+
end
|
|
317
|
+
return data, status_code, headers
|
|
318
|
+
end
|
|
319
|
+
|
|
320
|
+
# Delete a metadata field
|
|
321
|
+
# Deletes a metadata field from its template together with every value written for it on any file, folder or room of the portal. Only a DocSpace admin can change templates. The deletion is irreversible: the affected entries lose the value at once, their search documents are rebuilt and the clients viewing them are told to refresh. The template and its other fields stay as they are. A field that does not exist, or that belongs to another template than the one in the route, is answered with 404.
|
|
322
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/delete-field/
|
|
323
|
+
# @param template_id [Integer] The template ID.
|
|
324
|
+
# @param field_id [Integer] The field ID.
|
|
325
|
+
# @param [Hash] opts the optional parameters
|
|
326
|
+
# @return [nil]
|
|
327
|
+
def delete_field(template_id, field_id, opts = {})
|
|
328
|
+
delete_field_with_http_info(template_id, field_id, opts)
|
|
329
|
+
nil
|
|
330
|
+
end
|
|
331
|
+
|
|
332
|
+
# Delete a metadata field
|
|
333
|
+
# Deletes a metadata field from its template together with every value written for it on any file, folder or room of the portal. Only a DocSpace admin can change templates. The deletion is irreversible: the affected entries lose the value at once, their search documents are rebuilt and the clients viewing them are told to refresh. The template and its other fields stay as they are. A field that does not exist, or that belongs to another template than the one in the route, is answered with 404.
|
|
334
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/delete-field/
|
|
335
|
+
# @param template_id [Integer] The template ID.
|
|
336
|
+
# @param field_id [Integer] The field ID.
|
|
337
|
+
# @param [Hash] opts the optional parameters
|
|
338
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
339
|
+
def delete_field_with_http_info(template_id, field_id, opts = {})
|
|
340
|
+
if @api_client.config.debugging
|
|
341
|
+
@api_client.config.logger.debug 'Calling API: Files::MetadataApi.delete_field ...'
|
|
342
|
+
end
|
|
343
|
+
# verify the required parameter 'template_id' is set
|
|
344
|
+
if @api_client.config.client_side_validation && template_id.nil?
|
|
345
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling Files::MetadataApi.delete_field"
|
|
346
|
+
end
|
|
347
|
+
# verify the required parameter 'field_id' is set
|
|
348
|
+
if @api_client.config.client_side_validation && field_id.nil?
|
|
349
|
+
fail ArgumentError, "Missing the required parameter 'field_id' when calling Files::MetadataApi.delete_field"
|
|
350
|
+
end
|
|
351
|
+
# resource path
|
|
352
|
+
local_var_path = '/api/2.0/files/metadata/templates/{templateId}/fields/{fieldId}'.sub('{' + 'templateId' + '}', CGI.escape(template_id.to_s)).sub('{' + 'fieldId' + '}', CGI.escape(field_id.to_s))
|
|
353
|
+
|
|
354
|
+
# query parameters
|
|
355
|
+
query_params = opts[:query_params] || {}
|
|
356
|
+
|
|
357
|
+
# header parameters
|
|
358
|
+
header_params = opts[:header_params] || {}
|
|
359
|
+
# HTTP header 'Accept' (if needed)
|
|
360
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
361
|
+
|
|
362
|
+
# form parameters
|
|
363
|
+
form_params = opts[:form_params] || {}
|
|
364
|
+
|
|
365
|
+
# http body (model)
|
|
366
|
+
post_body = opts[:debug_body]
|
|
367
|
+
|
|
368
|
+
# return_type
|
|
369
|
+
return_type = opts[:debug_return_type]
|
|
370
|
+
|
|
371
|
+
# auth_names
|
|
372
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
373
|
+
|
|
374
|
+
new_options = opts.merge(
|
|
375
|
+
:operation => :"Files::MetadataApi.delete_field",
|
|
376
|
+
:header_params => header_params,
|
|
377
|
+
:query_params => query_params,
|
|
378
|
+
:form_params => form_params,
|
|
379
|
+
:body => post_body,
|
|
380
|
+
:auth_names => auth_names,
|
|
381
|
+
:return_type => return_type
|
|
382
|
+
)
|
|
383
|
+
|
|
384
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
385
|
+
if @api_client.config.debugging
|
|
386
|
+
@api_client.config.logger.debug "API called: Files::MetadataApi#delete_field\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
387
|
+
end
|
|
388
|
+
return data, status_code, headers
|
|
389
|
+
end
|
|
390
|
+
|
|
391
|
+
# Delete a metadata template
|
|
392
|
+
# Deletes a metadata template together with its fields, its assignments and every value written for its fields on any file, folder or room of the portal. Only a DocSpace admin can delete templates. The deletion is irreversible and there is no confirmation: the affected entries lose the template at once, their search documents are rebuilt and the clients viewing them are told to refresh. A template that does not exist, or was already deleted, is answered with 404. To take the template off a single entry and keep it for the others use `DELETE api/2.0/files/metadata/file/{fileId}/templates/{templateId}` instead.
|
|
393
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/delete-template/
|
|
394
|
+
# @param template_id [Integer] The template ID.
|
|
395
|
+
# @param [Hash] opts the optional parameters
|
|
396
|
+
# @return [nil]
|
|
397
|
+
def delete_template(template_id, opts = {})
|
|
398
|
+
delete_template_with_http_info(template_id, opts)
|
|
399
|
+
nil
|
|
400
|
+
end
|
|
401
|
+
|
|
402
|
+
# Delete a metadata template
|
|
403
|
+
# Deletes a metadata template together with its fields, its assignments and every value written for its fields on any file, folder or room of the portal. Only a DocSpace admin can delete templates. The deletion is irreversible and there is no confirmation: the affected entries lose the template at once, their search documents are rebuilt and the clients viewing them are told to refresh. A template that does not exist, or was already deleted, is answered with 404. To take the template off a single entry and keep it for the others use `DELETE api/2.0/files/metadata/file/{fileId}/templates/{templateId}` instead.
|
|
404
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/delete-template/
|
|
405
|
+
# @param template_id [Integer] The template ID.
|
|
406
|
+
# @param [Hash] opts the optional parameters
|
|
407
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
408
|
+
def delete_template_with_http_info(template_id, opts = {})
|
|
409
|
+
if @api_client.config.debugging
|
|
410
|
+
@api_client.config.logger.debug 'Calling API: Files::MetadataApi.delete_template ...'
|
|
411
|
+
end
|
|
412
|
+
# verify the required parameter 'template_id' is set
|
|
413
|
+
if @api_client.config.client_side_validation && template_id.nil?
|
|
414
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling Files::MetadataApi.delete_template"
|
|
415
|
+
end
|
|
416
|
+
# resource path
|
|
417
|
+
local_var_path = '/api/2.0/files/metadata/templates/{templateId}'.sub('{' + 'templateId' + '}', CGI.escape(template_id.to_s))
|
|
418
|
+
|
|
419
|
+
# query parameters
|
|
420
|
+
query_params = opts[:query_params] || {}
|
|
421
|
+
|
|
422
|
+
# header parameters
|
|
423
|
+
header_params = opts[:header_params] || {}
|
|
424
|
+
# HTTP header 'Accept' (if needed)
|
|
425
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
426
|
+
|
|
427
|
+
# form parameters
|
|
428
|
+
form_params = opts[:form_params] || {}
|
|
429
|
+
|
|
430
|
+
# http body (model)
|
|
431
|
+
post_body = opts[:debug_body]
|
|
432
|
+
|
|
433
|
+
# return_type
|
|
434
|
+
return_type = opts[:debug_return_type]
|
|
435
|
+
|
|
436
|
+
# auth_names
|
|
437
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
438
|
+
|
|
439
|
+
new_options = opts.merge(
|
|
440
|
+
:operation => :"Files::MetadataApi.delete_template",
|
|
441
|
+
:header_params => header_params,
|
|
442
|
+
:query_params => query_params,
|
|
443
|
+
:form_params => form_params,
|
|
444
|
+
:body => post_body,
|
|
445
|
+
:auth_names => auth_names,
|
|
446
|
+
:return_type => return_type
|
|
447
|
+
)
|
|
448
|
+
|
|
449
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
450
|
+
if @api_client.config.debugging
|
|
451
|
+
@api_client.config.logger.debug "API called: Files::MetadataApi#delete_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
452
|
+
end
|
|
453
|
+
return data, status_code, headers
|
|
454
|
+
end
|
|
455
|
+
|
|
456
|
+
# Get cascade progress
|
|
457
|
+
# Reports the cascade pass of a folder started by `PUT api/2.0/files/metadata/folder/{folderId}/templates` or by `PUT api/2.0/files/metadata/folder/{folderId}/templates/{templateId}`: the running one, otherwise the most recent one. The caller needs read access to the folder, the call is read-only. `templateIds` names the templates the pass propagates, so a client can show the progress next to the right template; `progress` is the share of the subtree processed, `isCompleted` tells the pass is over and `error` carries the reason of a failed one; a completed pass without an error has written every template and value it was asked for. A folder that never cascaded, or whose passes were already dropped, is answered with a completed operation without an identifier and with empty `templateIds` rather than with an error. A folder that does not exist is answered with 404.
|
|
458
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-cascade-progress/
|
|
459
|
+
# @param folder_id [Integer] The folder the operation acts on. Take the identifier from a listing such as `GET api/2.0/files/@root` or `GET api/2.0/files/{folderId}`: a folder stored in the portal is numbered, while a folder in a connected third-party account is named by an opaque string.
|
|
460
|
+
# @param [Hash] opts the optional parameters
|
|
461
|
+
# @return [MetadataOperationWrapper]
|
|
462
|
+
def get_cascade_progress(folder_id, opts = {})
|
|
463
|
+
data, _status_code, _headers = get_cascade_progress_with_http_info(folder_id, opts)
|
|
464
|
+
data
|
|
465
|
+
end
|
|
466
|
+
|
|
467
|
+
# Get cascade progress
|
|
468
|
+
# Reports the cascade pass of a folder started by `PUT api/2.0/files/metadata/folder/{folderId}/templates` or by `PUT api/2.0/files/metadata/folder/{folderId}/templates/{templateId}`: the running one, otherwise the most recent one. The caller needs read access to the folder, the call is read-only. `templateIds` names the templates the pass propagates, so a client can show the progress next to the right template; `progress` is the share of the subtree processed, `isCompleted` tells the pass is over and `error` carries the reason of a failed one; a completed pass without an error has written every template and value it was asked for. A folder that never cascaded, or whose passes were already dropped, is answered with a completed operation without an identifier and with empty `templateIds` rather than with an error. A folder that does not exist is answered with 404.
|
|
469
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-cascade-progress/
|
|
470
|
+
# @param folder_id [Integer] The folder the operation acts on. Take the identifier from a listing such as `GET api/2.0/files/@root` or `GET api/2.0/files/{folderId}`: a folder stored in the portal is numbered, while a folder in a connected third-party account is named by an opaque string.
|
|
471
|
+
# @param [Hash] opts the optional parameters
|
|
472
|
+
# @return [Array<(MetadataOperationWrapper, Integer, Hash)>] MetadataOperationWrapper data, response status code and response headers
|
|
473
|
+
def get_cascade_progress_with_http_info(folder_id, opts = {})
|
|
474
|
+
if @api_client.config.debugging
|
|
475
|
+
@api_client.config.logger.debug 'Calling API: Files::MetadataApi.get_cascade_progress ...'
|
|
476
|
+
end
|
|
477
|
+
# verify the required parameter 'folder_id' is set
|
|
478
|
+
if @api_client.config.client_side_validation && folder_id.nil?
|
|
479
|
+
fail ArgumentError, "Missing the required parameter 'folder_id' when calling Files::MetadataApi.get_cascade_progress"
|
|
480
|
+
end
|
|
481
|
+
# resource path
|
|
482
|
+
local_var_path = '/api/2.0/files/metadata/folder/{folderId}/templates/progress'.sub('{' + 'folderId' + '}', CGI.escape(folder_id.to_s))
|
|
483
|
+
|
|
484
|
+
# query parameters
|
|
485
|
+
query_params = opts[:query_params] || {}
|
|
486
|
+
|
|
487
|
+
# header parameters
|
|
488
|
+
header_params = opts[:header_params] || {}
|
|
489
|
+
# HTTP header 'Accept' (if needed)
|
|
490
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
491
|
+
|
|
492
|
+
# form parameters
|
|
493
|
+
form_params = opts[:form_params] || {}
|
|
494
|
+
|
|
495
|
+
# http body (model)
|
|
496
|
+
post_body = opts[:debug_body]
|
|
497
|
+
|
|
498
|
+
# return_type
|
|
499
|
+
return_type = opts[:debug_return_type] || 'MetadataOperationWrapper'
|
|
500
|
+
|
|
501
|
+
# auth_names
|
|
502
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
503
|
+
|
|
504
|
+
new_options = opts.merge(
|
|
505
|
+
:operation => :"Files::MetadataApi.get_cascade_progress",
|
|
506
|
+
:header_params => header_params,
|
|
507
|
+
:query_params => query_params,
|
|
508
|
+
:form_params => form_params,
|
|
509
|
+
:body => post_body,
|
|
510
|
+
:auth_names => auth_names,
|
|
511
|
+
:return_type => return_type
|
|
512
|
+
)
|
|
513
|
+
|
|
514
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
515
|
+
if @api_client.config.debugging
|
|
516
|
+
@api_client.config.logger.debug "API called: Files::MetadataApi#get_cascade_progress\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
517
|
+
end
|
|
518
|
+
return data, status_code, headers
|
|
519
|
+
end
|
|
520
|
+
|
|
521
|
+
# Get file metadata
|
|
522
|
+
# Returns the metadata of a file: the templates assigned to it, directly or inherited from a cascading folder above it, each with its fields, and the custom text fields set on the file. The caller needs read access to the file: a member of the portal, or an anonymous caller through an external link that grants access to the file or to a folder above it, with the link key in the `Request-Token` header or in the `share` query parameter. The call is read-only. A field carries its value inside it; a field the file holds no value for comes without a `value`. A file never cascades, so every template reports `cascade` false and no `conflictResolveType`; whether it was inherited from a folder above is not told apart from a direct assignment. The custom fields are name and value pairs and are not part of any template. A file without metadata is answered with empty lists, not with an error. The same shape is returned by `PUT api/2.0/files/metadata/file/{fileId}/values` after a write. A request with neither a session nor a link key is answered with 401; a file the caller cannot read with 403, a file that does not exist with 404.
|
|
523
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-file-metadata/
|
|
524
|
+
# @param file_id [Integer] The file the operation addresses. Take the identifier from a listing such as `GET api/2.0/files/{folderId}`: a file stored on the portal is numbered, while a file in a connected third-party account is named by an opaque string.
|
|
525
|
+
# @param [Hash] opts the optional parameters
|
|
526
|
+
# @return [EntryMetadataWrapper]
|
|
527
|
+
def get_file_metadata(file_id, opts = {})
|
|
528
|
+
data, _status_code, _headers = get_file_metadata_with_http_info(file_id, opts)
|
|
529
|
+
data
|
|
530
|
+
end
|
|
531
|
+
|
|
532
|
+
# Get file metadata
|
|
533
|
+
# Returns the metadata of a file: the templates assigned to it, directly or inherited from a cascading folder above it, each with its fields, and the custom text fields set on the file. The caller needs read access to the file: a member of the portal, or an anonymous caller through an external link that grants access to the file or to a folder above it, with the link key in the `Request-Token` header or in the `share` query parameter. The call is read-only. A field carries its value inside it; a field the file holds no value for comes without a `value`. A file never cascades, so every template reports `cascade` false and no `conflictResolveType`; whether it was inherited from a folder above is not told apart from a direct assignment. The custom fields are name and value pairs and are not part of any template. A file without metadata is answered with empty lists, not with an error. The same shape is returned by `PUT api/2.0/files/metadata/file/{fileId}/values` after a write. A request with neither a session nor a link key is answered with 401; a file the caller cannot read with 403, a file that does not exist with 404.
|
|
534
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-file-metadata/
|
|
535
|
+
# @param file_id [Integer] The file the operation addresses. Take the identifier from a listing such as `GET api/2.0/files/{folderId}`: a file stored on the portal is numbered, while a file in a connected third-party account is named by an opaque string.
|
|
536
|
+
# @param [Hash] opts the optional parameters
|
|
537
|
+
# @return [Array<(EntryMetadataWrapper, Integer, Hash)>] EntryMetadataWrapper data, response status code and response headers
|
|
538
|
+
def get_file_metadata_with_http_info(file_id, opts = {})
|
|
539
|
+
if @api_client.config.debugging
|
|
540
|
+
@api_client.config.logger.debug 'Calling API: Files::MetadataApi.get_file_metadata ...'
|
|
541
|
+
end
|
|
542
|
+
# verify the required parameter 'file_id' is set
|
|
543
|
+
if @api_client.config.client_side_validation && file_id.nil?
|
|
544
|
+
fail ArgumentError, "Missing the required parameter 'file_id' when calling Files::MetadataApi.get_file_metadata"
|
|
545
|
+
end
|
|
546
|
+
# resource path
|
|
547
|
+
local_var_path = '/api/2.0/files/metadata/file/{fileId}'.sub('{' + 'fileId' + '}', CGI.escape(file_id.to_s))
|
|
548
|
+
|
|
549
|
+
# query parameters
|
|
550
|
+
query_params = opts[:query_params] || {}
|
|
551
|
+
|
|
552
|
+
# header parameters
|
|
553
|
+
header_params = opts[:header_params] || {}
|
|
554
|
+
# HTTP header 'Accept' (if needed)
|
|
555
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
556
|
+
|
|
557
|
+
# form parameters
|
|
558
|
+
form_params = opts[:form_params] || {}
|
|
559
|
+
|
|
560
|
+
# http body (model)
|
|
561
|
+
post_body = opts[:debug_body]
|
|
562
|
+
|
|
563
|
+
# return_type
|
|
564
|
+
return_type = opts[:debug_return_type] || 'EntryMetadataWrapper'
|
|
565
|
+
|
|
566
|
+
# auth_names
|
|
567
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
568
|
+
|
|
569
|
+
new_options = opts.merge(
|
|
570
|
+
:operation => :"Files::MetadataApi.get_file_metadata",
|
|
571
|
+
:header_params => header_params,
|
|
572
|
+
:query_params => query_params,
|
|
573
|
+
:form_params => form_params,
|
|
574
|
+
:body => post_body,
|
|
575
|
+
:auth_names => auth_names,
|
|
576
|
+
:return_type => return_type
|
|
577
|
+
)
|
|
578
|
+
|
|
579
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
580
|
+
if @api_client.config.debugging
|
|
581
|
+
@api_client.config.logger.debug "API called: Files::MetadataApi#get_file_metadata\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
582
|
+
end
|
|
583
|
+
return data, status_code, headers
|
|
584
|
+
end
|
|
585
|
+
|
|
586
|
+
# Get folder metadata
|
|
587
|
+
# Returns the metadata of a folder or a room: the templates assigned to it, directly or inherited from a cascading folder above it, each with its fields, and the custom text fields set on it. The caller needs read access to the folder: a member of the portal, or an anonymous caller through an external link to the folder or to a folder above it, with the link key in the `Request-Token` header or in the `share` query parameter. The call is read-only. A field carries its value inside it; a field without a value on the folder comes without `value`. Each template reports whether this folder cascades it to its content in `cascade`, with the rule of that cascade in `conflictResolveType`, absent while it does not; an inherited template reports false unless this folder cascades it on its own. The custom fields are name and value pairs outside any template. A folder without metadata is answered with empty lists. The cascade is changed with `PUT api/2.0/files/metadata/folder/{folderId}/templates/{templateId}`. A request with neither a session nor a link key is answered with 401; a folder the caller cannot read with 403, a folder that does not exist with 404.
|
|
588
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-folder-metadata/
|
|
589
|
+
# @param folder_id [Integer] The folder the operation acts on. Take the identifier from a listing such as `GET api/2.0/files/@root` or `GET api/2.0/files/{folderId}`: a folder stored in the portal is numbered, while a folder in a connected third-party account is named by an opaque string.
|
|
590
|
+
# @param [Hash] opts the optional parameters
|
|
591
|
+
# @return [EntryMetadataWrapper]
|
|
592
|
+
def get_folder_metadata(folder_id, opts = {})
|
|
593
|
+
data, _status_code, _headers = get_folder_metadata_with_http_info(folder_id, opts)
|
|
594
|
+
data
|
|
595
|
+
end
|
|
596
|
+
|
|
597
|
+
# Get folder metadata
|
|
598
|
+
# Returns the metadata of a folder or a room: the templates assigned to it, directly or inherited from a cascading folder above it, each with its fields, and the custom text fields set on it. The caller needs read access to the folder: a member of the portal, or an anonymous caller through an external link to the folder or to a folder above it, with the link key in the `Request-Token` header or in the `share` query parameter. The call is read-only. A field carries its value inside it; a field without a value on the folder comes without `value`. Each template reports whether this folder cascades it to its content in `cascade`, with the rule of that cascade in `conflictResolveType`, absent while it does not; an inherited template reports false unless this folder cascades it on its own. The custom fields are name and value pairs outside any template. A folder without metadata is answered with empty lists. The cascade is changed with `PUT api/2.0/files/metadata/folder/{folderId}/templates/{templateId}`. A request with neither a session nor a link key is answered with 401; a folder the caller cannot read with 403, a folder that does not exist with 404.
|
|
599
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-folder-metadata/
|
|
600
|
+
# @param folder_id [Integer] The folder the operation acts on. Take the identifier from a listing such as `GET api/2.0/files/@root` or `GET api/2.0/files/{folderId}`: a folder stored in the portal is numbered, while a folder in a connected third-party account is named by an opaque string.
|
|
601
|
+
# @param [Hash] opts the optional parameters
|
|
602
|
+
# @return [Array<(EntryMetadataWrapper, Integer, Hash)>] EntryMetadataWrapper data, response status code and response headers
|
|
603
|
+
def get_folder_metadata_with_http_info(folder_id, opts = {})
|
|
604
|
+
if @api_client.config.debugging
|
|
605
|
+
@api_client.config.logger.debug 'Calling API: Files::MetadataApi.get_folder_metadata ...'
|
|
606
|
+
end
|
|
607
|
+
# verify the required parameter 'folder_id' is set
|
|
608
|
+
if @api_client.config.client_side_validation && folder_id.nil?
|
|
609
|
+
fail ArgumentError, "Missing the required parameter 'folder_id' when calling Files::MetadataApi.get_folder_metadata"
|
|
610
|
+
end
|
|
611
|
+
# resource path
|
|
612
|
+
local_var_path = '/api/2.0/files/metadata/folder/{folderId}'.sub('{' + 'folderId' + '}', CGI.escape(folder_id.to_s))
|
|
613
|
+
|
|
614
|
+
# query parameters
|
|
615
|
+
query_params = opts[:query_params] || {}
|
|
616
|
+
|
|
617
|
+
# header parameters
|
|
618
|
+
header_params = opts[:header_params] || {}
|
|
619
|
+
# HTTP header 'Accept' (if needed)
|
|
620
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
621
|
+
|
|
622
|
+
# form parameters
|
|
623
|
+
form_params = opts[:form_params] || {}
|
|
624
|
+
|
|
625
|
+
# http body (model)
|
|
626
|
+
post_body = opts[:debug_body]
|
|
627
|
+
|
|
628
|
+
# return_type
|
|
629
|
+
return_type = opts[:debug_return_type] || 'EntryMetadataWrapper'
|
|
630
|
+
|
|
631
|
+
# auth_names
|
|
632
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
633
|
+
|
|
634
|
+
new_options = opts.merge(
|
|
635
|
+
:operation => :"Files::MetadataApi.get_folder_metadata",
|
|
636
|
+
:header_params => header_params,
|
|
637
|
+
:query_params => query_params,
|
|
638
|
+
:form_params => form_params,
|
|
639
|
+
:body => post_body,
|
|
640
|
+
:auth_names => auth_names,
|
|
641
|
+
:return_type => return_type
|
|
642
|
+
)
|
|
643
|
+
|
|
644
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
645
|
+
if @api_client.config.debugging
|
|
646
|
+
@api_client.config.logger.debug "API called: Files::MetadataApi#get_folder_metadata\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
647
|
+
end
|
|
648
|
+
return data, status_code, headers
|
|
649
|
+
end
|
|
650
|
+
|
|
651
|
+
# Get a metadata template
|
|
652
|
+
# Returns one metadata template with its fields, in their display order, and the options of its choice fields. Any member of the portal can read a template, the call is read-only. Use it to resolve the template identifiers a file or a folder reports in `assignedMetadataTemplates` into names and fields. A template that does not exist is answered with 404.
|
|
653
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-template/
|
|
654
|
+
# @param template_id [Integer] The template ID.
|
|
655
|
+
# @param [Hash] opts the optional parameters
|
|
656
|
+
# @return [MetadataTemplateWrapper]
|
|
657
|
+
def get_template(template_id, opts = {})
|
|
658
|
+
data, _status_code, _headers = get_template_with_http_info(template_id, opts)
|
|
659
|
+
data
|
|
660
|
+
end
|
|
661
|
+
|
|
662
|
+
# Get a metadata template
|
|
663
|
+
# Returns one metadata template with its fields, in their display order, and the options of its choice fields. Any member of the portal can read a template, the call is read-only. Use it to resolve the template identifiers a file or a folder reports in `assignedMetadataTemplates` into names and fields. A template that does not exist is answered with 404.
|
|
664
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-template/
|
|
665
|
+
# @param template_id [Integer] The template ID.
|
|
666
|
+
# @param [Hash] opts the optional parameters
|
|
667
|
+
# @return [Array<(MetadataTemplateWrapper, Integer, Hash)>] MetadataTemplateWrapper data, response status code and response headers
|
|
668
|
+
def get_template_with_http_info(template_id, opts = {})
|
|
669
|
+
if @api_client.config.debugging
|
|
670
|
+
@api_client.config.logger.debug 'Calling API: Files::MetadataApi.get_template ...'
|
|
671
|
+
end
|
|
672
|
+
# verify the required parameter 'template_id' is set
|
|
673
|
+
if @api_client.config.client_side_validation && template_id.nil?
|
|
674
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling Files::MetadataApi.get_template"
|
|
675
|
+
end
|
|
676
|
+
# resource path
|
|
677
|
+
local_var_path = '/api/2.0/files/metadata/templates/{templateId}'.sub('{' + 'templateId' + '}', CGI.escape(template_id.to_s))
|
|
678
|
+
|
|
679
|
+
# query parameters
|
|
680
|
+
query_params = opts[:query_params] || {}
|
|
681
|
+
|
|
682
|
+
# header parameters
|
|
683
|
+
header_params = opts[:header_params] || {}
|
|
684
|
+
# HTTP header 'Accept' (if needed)
|
|
685
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
686
|
+
|
|
687
|
+
# form parameters
|
|
688
|
+
form_params = opts[:form_params] || {}
|
|
689
|
+
|
|
690
|
+
# http body (model)
|
|
691
|
+
post_body = opts[:debug_body]
|
|
692
|
+
|
|
693
|
+
# return_type
|
|
694
|
+
return_type = opts[:debug_return_type] || 'MetadataTemplateWrapper'
|
|
695
|
+
|
|
696
|
+
# auth_names
|
|
697
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
698
|
+
|
|
699
|
+
new_options = opts.merge(
|
|
700
|
+
:operation => :"Files::MetadataApi.get_template",
|
|
701
|
+
:header_params => header_params,
|
|
702
|
+
:query_params => query_params,
|
|
703
|
+
:form_params => form_params,
|
|
704
|
+
:body => post_body,
|
|
705
|
+
:auth_names => auth_names,
|
|
706
|
+
:return_type => return_type
|
|
707
|
+
)
|
|
708
|
+
|
|
709
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
710
|
+
if @api_client.config.debugging
|
|
711
|
+
@api_client.config.logger.debug "API called: Files::MetadataApi#get_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
712
|
+
end
|
|
713
|
+
return data, status_code, headers
|
|
714
|
+
end
|
|
715
|
+
|
|
716
|
+
# Get metadata templates
|
|
717
|
+
# Lists the metadata templates of the portal with their fields, the dictionary a file, a folder or a room is described with. Any member of the portal can read it, the list is the same for everyone. The call is read-only. The templates come back ordered by their creation, each with its fields in their display order and the choice options of the choice fields; the `visible` parameter narrows the list to the templates shown in the pickers or to the hidden ones, without it both are returned. The author and the last editor of a template come as user objects with the display name and the avatar, so a list needs no lookup of its own per author. An empty list means the portal has no templates yet. The custom text fields set on the entries are not templates and are not listed here: read them on the entry with `GET api/2.0/files/metadata/file/{fileId}`.
|
|
718
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-templates/
|
|
719
|
+
# @param [Hash] opts the optional parameters
|
|
720
|
+
# @option opts [Boolean] :visible Filters the templates by their visibility.
|
|
721
|
+
# @return [MetadataTemplateArrayWrapper]
|
|
722
|
+
def get_templates(opts = {})
|
|
723
|
+
data, _status_code, _headers = get_templates_with_http_info(opts)
|
|
724
|
+
data
|
|
725
|
+
end
|
|
726
|
+
|
|
727
|
+
# Get metadata templates
|
|
728
|
+
# Lists the metadata templates of the portal with their fields, the dictionary a file, a folder or a room is described with. Any member of the portal can read it, the list is the same for everyone. The call is read-only. The templates come back ordered by their creation, each with its fields in their display order and the choice options of the choice fields; the `visible` parameter narrows the list to the templates shown in the pickers or to the hidden ones, without it both are returned. The author and the last editor of a template come as user objects with the display name and the avatar, so a list needs no lookup of its own per author. An empty list means the portal has no templates yet. The custom text fields set on the entries are not templates and are not listed here: read them on the entry with `GET api/2.0/files/metadata/file/{fileId}`.
|
|
729
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-templates/
|
|
730
|
+
# @param [Hash] opts the optional parameters
|
|
731
|
+
# @option opts [Boolean] :visible Filters the templates by their visibility.
|
|
732
|
+
# @return [Array<(MetadataTemplateArrayWrapper, Integer, Hash)>] MetadataTemplateArrayWrapper data, response status code and response headers
|
|
733
|
+
def get_templates_with_http_info(opts = {})
|
|
734
|
+
if @api_client.config.debugging
|
|
735
|
+
@api_client.config.logger.debug 'Calling API: Files::MetadataApi.get_templates ...'
|
|
736
|
+
end
|
|
737
|
+
# resource path
|
|
738
|
+
local_var_path = '/api/2.0/files/metadata/templates'
|
|
739
|
+
|
|
740
|
+
# query parameters
|
|
741
|
+
query_params = opts[:query_params] || {}
|
|
742
|
+
query_params[:'visible'] = opts[:'visible'] if !opts[:'visible'].nil?
|
|
743
|
+
|
|
744
|
+
# header parameters
|
|
745
|
+
header_params = opts[:header_params] || {}
|
|
746
|
+
# HTTP header 'Accept' (if needed)
|
|
747
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
748
|
+
|
|
749
|
+
# form parameters
|
|
750
|
+
form_params = opts[:form_params] || {}
|
|
751
|
+
|
|
752
|
+
# http body (model)
|
|
753
|
+
post_body = opts[:debug_body]
|
|
754
|
+
|
|
755
|
+
# return_type
|
|
756
|
+
return_type = opts[:debug_return_type] || 'MetadataTemplateArrayWrapper'
|
|
757
|
+
|
|
758
|
+
# auth_names
|
|
759
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
760
|
+
|
|
761
|
+
new_options = opts.merge(
|
|
762
|
+
:operation => :"Files::MetadataApi.get_templates",
|
|
763
|
+
:header_params => header_params,
|
|
764
|
+
:query_params => query_params,
|
|
765
|
+
:form_params => form_params,
|
|
766
|
+
:body => post_body,
|
|
767
|
+
:auth_names => auth_names,
|
|
768
|
+
:return_type => return_type
|
|
769
|
+
)
|
|
770
|
+
|
|
771
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
772
|
+
if @api_client.config.debugging
|
|
773
|
+
@api_client.config.logger.debug "API called: Files::MetadataApi#get_templates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
774
|
+
end
|
|
775
|
+
return data, status_code, headers
|
|
776
|
+
end
|
|
777
|
+
|
|
778
|
+
# Set file custom fields
|
|
779
|
+
# Sets the custom text fields of a file: free-form name and value pairs that need no template. The caller needs the right to edit the file. A field is addressed by its name regardless of case: a listed name gets the value, a null or empty value removes the field from the file, the names not listed are left alone, so a partial request is safe. A name the portal has not seen yet creates the field for the whole portal, and a name no entry holds a value for any more is dropped, so the set of names follows the values. A name is at most 255 characters, a value at most 8000, a name may be listed once and a file holds at most 50 custom fields. The write finishes in the request; the values take part in the free text search and in the `metadataFilters` of the listings. The answer is the custom fields of the file after the write. An empty list, a blank, repeated or over-long name, an over-long value or more than 50 fields is answered with 400; a file the caller cannot edit with 403; a file that does not exist with 404.
|
|
780
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/set-file-custom-fields/
|
|
781
|
+
# @param file_id [Integer] The file ID.
|
|
782
|
+
# @param set_custom_fields [SetCustomFields] The custom fields to set.
|
|
783
|
+
# @param [Hash] opts the optional parameters
|
|
784
|
+
# @return [CustomFieldValueArrayWrapper]
|
|
785
|
+
def set_file_custom_fields(file_id, set_custom_fields, opts = {})
|
|
786
|
+
data, _status_code, _headers = set_file_custom_fields_with_http_info(file_id, set_custom_fields, opts)
|
|
787
|
+
data
|
|
788
|
+
end
|
|
789
|
+
|
|
790
|
+
# Set file custom fields
|
|
791
|
+
# Sets the custom text fields of a file: free-form name and value pairs that need no template. The caller needs the right to edit the file. A field is addressed by its name regardless of case: a listed name gets the value, a null or empty value removes the field from the file, the names not listed are left alone, so a partial request is safe. A name the portal has not seen yet creates the field for the whole portal, and a name no entry holds a value for any more is dropped, so the set of names follows the values. A name is at most 255 characters, a value at most 8000, a name may be listed once and a file holds at most 50 custom fields. The write finishes in the request; the values take part in the free text search and in the `metadataFilters` of the listings. The answer is the custom fields of the file after the write. An empty list, a blank, repeated or over-long name, an over-long value or more than 50 fields is answered with 400; a file the caller cannot edit with 403; a file that does not exist with 404.
|
|
792
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/set-file-custom-fields/
|
|
793
|
+
# @param file_id [Integer] The file ID.
|
|
794
|
+
# @param set_custom_fields [SetCustomFields] The custom fields to set.
|
|
795
|
+
# @param [Hash] opts the optional parameters
|
|
796
|
+
# @return [Array<(CustomFieldValueArrayWrapper, Integer, Hash)>] CustomFieldValueArrayWrapper data, response status code and response headers
|
|
797
|
+
def set_file_custom_fields_with_http_info(file_id, set_custom_fields, opts = {})
|
|
798
|
+
if @api_client.config.debugging
|
|
799
|
+
@api_client.config.logger.debug 'Calling API: Files::MetadataApi.set_file_custom_fields ...'
|
|
800
|
+
end
|
|
801
|
+
# verify the required parameter 'file_id' is set
|
|
802
|
+
if @api_client.config.client_side_validation && file_id.nil?
|
|
803
|
+
fail ArgumentError, "Missing the required parameter 'file_id' when calling Files::MetadataApi.set_file_custom_fields"
|
|
804
|
+
end
|
|
805
|
+
# verify the required parameter 'set_custom_fields' is set
|
|
806
|
+
if @api_client.config.client_side_validation && set_custom_fields.nil?
|
|
807
|
+
fail ArgumentError, "Missing the required parameter 'set_custom_fields' when calling Files::MetadataApi.set_file_custom_fields"
|
|
808
|
+
end
|
|
809
|
+
# resource path
|
|
810
|
+
local_var_path = '/api/2.0/files/metadata/file/{fileId}/customfields'.sub('{' + 'fileId' + '}', CGI.escape(file_id.to_s))
|
|
811
|
+
|
|
812
|
+
# query parameters
|
|
813
|
+
query_params = opts[:query_params] || {}
|
|
814
|
+
|
|
815
|
+
# header parameters
|
|
816
|
+
header_params = opts[:header_params] || {}
|
|
817
|
+
# HTTP header 'Accept' (if needed)
|
|
818
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
819
|
+
# HTTP header 'Content-Type'
|
|
820
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
821
|
+
if !content_type.nil?
|
|
822
|
+
header_params['Content-Type'] = content_type
|
|
823
|
+
end
|
|
824
|
+
|
|
825
|
+
# form parameters
|
|
826
|
+
form_params = opts[:form_params] || {}
|
|
827
|
+
|
|
828
|
+
# http body (model)
|
|
829
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(set_custom_fields)
|
|
830
|
+
|
|
831
|
+
# return_type
|
|
832
|
+
return_type = opts[:debug_return_type] || 'CustomFieldValueArrayWrapper'
|
|
833
|
+
|
|
834
|
+
# auth_names
|
|
835
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
836
|
+
|
|
837
|
+
new_options = opts.merge(
|
|
838
|
+
:operation => :"Files::MetadataApi.set_file_custom_fields",
|
|
839
|
+
:header_params => header_params,
|
|
840
|
+
:query_params => query_params,
|
|
841
|
+
:form_params => form_params,
|
|
842
|
+
:body => post_body,
|
|
843
|
+
:auth_names => auth_names,
|
|
844
|
+
:return_type => return_type
|
|
845
|
+
)
|
|
846
|
+
|
|
847
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
848
|
+
if @api_client.config.debugging
|
|
849
|
+
@api_client.config.logger.debug "API called: Files::MetadataApi#set_file_custom_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
850
|
+
end
|
|
851
|
+
return data, status_code, headers
|
|
852
|
+
end
|
|
853
|
+
|
|
854
|
+
# Set file metadata values
|
|
855
|
+
# Writes the values of metadata fields on a file. The caller needs the right to edit the file: a member with editing access, or an anonymous caller through an external link that grants editing, with the link key in the `Request-Token` header or in the `share` query parameter; a link that grants viewing, commenting, reviewing or form filling only is refused. Every field must belong to a template the file carries, assigned with `PUT api/2.0/files/metadata/file/{fileId}/templates` or inherited from a cascading folder, and a field may be listed once. A value carries exactly the member of its type: `stringValue` for a text field of at most 8000 characters, `numberValue` for a number, `dateValue` for a date, `optionIds` for a choice field, a single option for a single choice; an empty value clears the field. A date without a time zone offset is read as UTC. The write finishes in the request, the file is re-indexed for the metadata filters at once. The custom text fields are not written here: use `PUT api/2.0/files/metadata/file/{fileId}/customFields`. The answer is the whole metadata of the file after the write, the same shape `GET api/2.0/files/metadata/file/{fileId}` returns. A value of the wrong type, a field of a template the file does not carry, a field listed twice or a custom field is answered with 400; a request with neither a session nor a link key with 401; a file the caller cannot edit with 403; a file or a field that does not exist with 404.
|
|
856
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/set-file-values/
|
|
857
|
+
# @param file_id [Integer] The file ID.
|
|
858
|
+
# @param set_metadata_values [SetMetadataValues] The parameters for setting values.
|
|
859
|
+
# @param [Hash] opts the optional parameters
|
|
860
|
+
# @return [EntryMetadataWrapper]
|
|
861
|
+
def set_file_values(file_id, set_metadata_values, opts = {})
|
|
862
|
+
data, _status_code, _headers = set_file_values_with_http_info(file_id, set_metadata_values, opts)
|
|
863
|
+
data
|
|
864
|
+
end
|
|
865
|
+
|
|
866
|
+
# Set file metadata values
|
|
867
|
+
# Writes the values of metadata fields on a file. The caller needs the right to edit the file: a member with editing access, or an anonymous caller through an external link that grants editing, with the link key in the `Request-Token` header or in the `share` query parameter; a link that grants viewing, commenting, reviewing or form filling only is refused. Every field must belong to a template the file carries, assigned with `PUT api/2.0/files/metadata/file/{fileId}/templates` or inherited from a cascading folder, and a field may be listed once. A value carries exactly the member of its type: `stringValue` for a text field of at most 8000 characters, `numberValue` for a number, `dateValue` for a date, `optionIds` for a choice field, a single option for a single choice; an empty value clears the field. A date without a time zone offset is read as UTC. The write finishes in the request, the file is re-indexed for the metadata filters at once. The custom text fields are not written here: use `PUT api/2.0/files/metadata/file/{fileId}/customFields`. The answer is the whole metadata of the file after the write, the same shape `GET api/2.0/files/metadata/file/{fileId}` returns. A value of the wrong type, a field of a template the file does not carry, a field listed twice or a custom field is answered with 400; a request with neither a session nor a link key with 401; a file the caller cannot edit with 403; a file or a field that does not exist with 404.
|
|
868
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/set-file-values/
|
|
869
|
+
# @param file_id [Integer] The file ID.
|
|
870
|
+
# @param set_metadata_values [SetMetadataValues] The parameters for setting values.
|
|
871
|
+
# @param [Hash] opts the optional parameters
|
|
872
|
+
# @return [Array<(EntryMetadataWrapper, Integer, Hash)>] EntryMetadataWrapper data, response status code and response headers
|
|
873
|
+
def set_file_values_with_http_info(file_id, set_metadata_values, opts = {})
|
|
874
|
+
if @api_client.config.debugging
|
|
875
|
+
@api_client.config.logger.debug 'Calling API: Files::MetadataApi.set_file_values ...'
|
|
876
|
+
end
|
|
877
|
+
# verify the required parameter 'file_id' is set
|
|
878
|
+
if @api_client.config.client_side_validation && file_id.nil?
|
|
879
|
+
fail ArgumentError, "Missing the required parameter 'file_id' when calling Files::MetadataApi.set_file_values"
|
|
880
|
+
end
|
|
881
|
+
# verify the required parameter 'set_metadata_values' is set
|
|
882
|
+
if @api_client.config.client_side_validation && set_metadata_values.nil?
|
|
883
|
+
fail ArgumentError, "Missing the required parameter 'set_metadata_values' when calling Files::MetadataApi.set_file_values"
|
|
884
|
+
end
|
|
885
|
+
# resource path
|
|
886
|
+
local_var_path = '/api/2.0/files/metadata/file/{fileId}/values'.sub('{' + 'fileId' + '}', CGI.escape(file_id.to_s))
|
|
887
|
+
|
|
888
|
+
# query parameters
|
|
889
|
+
query_params = opts[:query_params] || {}
|
|
890
|
+
|
|
891
|
+
# header parameters
|
|
892
|
+
header_params = opts[:header_params] || {}
|
|
893
|
+
# HTTP header 'Accept' (if needed)
|
|
894
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
895
|
+
# HTTP header 'Content-Type'
|
|
896
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
897
|
+
if !content_type.nil?
|
|
898
|
+
header_params['Content-Type'] = content_type
|
|
899
|
+
end
|
|
900
|
+
|
|
901
|
+
# form parameters
|
|
902
|
+
form_params = opts[:form_params] || {}
|
|
903
|
+
|
|
904
|
+
# http body (model)
|
|
905
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(set_metadata_values)
|
|
906
|
+
|
|
907
|
+
# return_type
|
|
908
|
+
return_type = opts[:debug_return_type] || 'EntryMetadataWrapper'
|
|
909
|
+
|
|
910
|
+
# auth_names
|
|
911
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
912
|
+
|
|
913
|
+
new_options = opts.merge(
|
|
914
|
+
:operation => :"Files::MetadataApi.set_file_values",
|
|
915
|
+
:header_params => header_params,
|
|
916
|
+
:query_params => query_params,
|
|
917
|
+
:form_params => form_params,
|
|
918
|
+
:body => post_body,
|
|
919
|
+
:auth_names => auth_names,
|
|
920
|
+
:return_type => return_type
|
|
921
|
+
)
|
|
922
|
+
|
|
923
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
924
|
+
if @api_client.config.debugging
|
|
925
|
+
@api_client.config.logger.debug "API called: Files::MetadataApi#set_file_values\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
926
|
+
end
|
|
927
|
+
return data, status_code, headers
|
|
928
|
+
end
|
|
929
|
+
|
|
930
|
+
# Set folder custom fields
|
|
931
|
+
# Sets the custom text fields of a folder or a room: free-form name and value pairs that need no template. The caller needs the right to create in the folder (a room manager or a content creator); for a room that is its manager. A field is addressed by its name regardless of case: a listed name gets the value, a null or empty value removes the field, the names not listed are left alone. A new name creates the field for the whole portal, and a name no entry holds a value for any more is dropped. A name is at most 255 characters, a value at most 8000, a name may be listed once and a folder holds at most 50 custom fields. The custom fields never cascade to the content of the folder. The write finishes in the request. The answer is the custom fields of the folder after the write. An empty list, a blank, repeated or over-long name, an over-long value or more than 50 fields is answered with 400; a caller without the right to create in the folder with 403; a folder that does not exist with 404.
|
|
932
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/set-folder-custom-fields/
|
|
933
|
+
# @param folder_id [Integer] The folder ID.
|
|
934
|
+
# @param set_custom_fields [SetCustomFields] The custom fields to set.
|
|
935
|
+
# @param [Hash] opts the optional parameters
|
|
936
|
+
# @return [CustomFieldValueArrayWrapper]
|
|
937
|
+
def set_folder_custom_fields(folder_id, set_custom_fields, opts = {})
|
|
938
|
+
data, _status_code, _headers = set_folder_custom_fields_with_http_info(folder_id, set_custom_fields, opts)
|
|
939
|
+
data
|
|
940
|
+
end
|
|
941
|
+
|
|
942
|
+
# Set folder custom fields
|
|
943
|
+
# Sets the custom text fields of a folder or a room: free-form name and value pairs that need no template. The caller needs the right to create in the folder (a room manager or a content creator); for a room that is its manager. A field is addressed by its name regardless of case: a listed name gets the value, a null or empty value removes the field, the names not listed are left alone. A new name creates the field for the whole portal, and a name no entry holds a value for any more is dropped. A name is at most 255 characters, a value at most 8000, a name may be listed once and a folder holds at most 50 custom fields. The custom fields never cascade to the content of the folder. The write finishes in the request. The answer is the custom fields of the folder after the write. An empty list, a blank, repeated or over-long name, an over-long value or more than 50 fields is answered with 400; a caller without the right to create in the folder with 403; a folder that does not exist with 404.
|
|
944
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/set-folder-custom-fields/
|
|
945
|
+
# @param folder_id [Integer] The folder ID.
|
|
946
|
+
# @param set_custom_fields [SetCustomFields] The custom fields to set.
|
|
947
|
+
# @param [Hash] opts the optional parameters
|
|
948
|
+
# @return [Array<(CustomFieldValueArrayWrapper, Integer, Hash)>] CustomFieldValueArrayWrapper data, response status code and response headers
|
|
949
|
+
def set_folder_custom_fields_with_http_info(folder_id, set_custom_fields, opts = {})
|
|
950
|
+
if @api_client.config.debugging
|
|
951
|
+
@api_client.config.logger.debug 'Calling API: Files::MetadataApi.set_folder_custom_fields ...'
|
|
952
|
+
end
|
|
953
|
+
# verify the required parameter 'folder_id' is set
|
|
954
|
+
if @api_client.config.client_side_validation && folder_id.nil?
|
|
955
|
+
fail ArgumentError, "Missing the required parameter 'folder_id' when calling Files::MetadataApi.set_folder_custom_fields"
|
|
956
|
+
end
|
|
957
|
+
# verify the required parameter 'set_custom_fields' is set
|
|
958
|
+
if @api_client.config.client_side_validation && set_custom_fields.nil?
|
|
959
|
+
fail ArgumentError, "Missing the required parameter 'set_custom_fields' when calling Files::MetadataApi.set_folder_custom_fields"
|
|
960
|
+
end
|
|
961
|
+
# resource path
|
|
962
|
+
local_var_path = '/api/2.0/files/metadata/folder/{folderId}/customfields'.sub('{' + 'folderId' + '}', CGI.escape(folder_id.to_s))
|
|
963
|
+
|
|
964
|
+
# query parameters
|
|
965
|
+
query_params = opts[:query_params] || {}
|
|
966
|
+
|
|
967
|
+
# header parameters
|
|
968
|
+
header_params = opts[:header_params] || {}
|
|
969
|
+
# HTTP header 'Accept' (if needed)
|
|
970
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
971
|
+
# HTTP header 'Content-Type'
|
|
972
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
973
|
+
if !content_type.nil?
|
|
974
|
+
header_params['Content-Type'] = content_type
|
|
975
|
+
end
|
|
976
|
+
|
|
977
|
+
# form parameters
|
|
978
|
+
form_params = opts[:form_params] || {}
|
|
979
|
+
|
|
980
|
+
# http body (model)
|
|
981
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(set_custom_fields)
|
|
982
|
+
|
|
983
|
+
# return_type
|
|
984
|
+
return_type = opts[:debug_return_type] || 'CustomFieldValueArrayWrapper'
|
|
985
|
+
|
|
986
|
+
# auth_names
|
|
987
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
988
|
+
|
|
989
|
+
new_options = opts.merge(
|
|
990
|
+
:operation => :"Files::MetadataApi.set_folder_custom_fields",
|
|
991
|
+
:header_params => header_params,
|
|
992
|
+
:query_params => query_params,
|
|
993
|
+
:form_params => form_params,
|
|
994
|
+
:body => post_body,
|
|
995
|
+
:auth_names => auth_names,
|
|
996
|
+
:return_type => return_type
|
|
997
|
+
)
|
|
998
|
+
|
|
999
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
1000
|
+
if @api_client.config.debugging
|
|
1001
|
+
@api_client.config.logger.debug "API called: Files::MetadataApi#set_folder_custom_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1002
|
+
end
|
|
1003
|
+
return data, status_code, headers
|
|
1004
|
+
end
|
|
1005
|
+
|
|
1006
|
+
# Set folder metadata values
|
|
1007
|
+
# Writes the values of metadata fields on a folder or a room. The caller needs the right to create in the folder (a room manager or a content creator); for a room that is its manager. Every field must belong to a template the folder carries, assigned with `PUT api/2.0/files/metadata/folder/{folderId}/templates` or inherited from a cascading folder, and a field may be listed once. A value carries exactly the member of its type: `stringValue` for a text field of at most 8000 characters, `numberValue` for a number, `dateValue` for a date, `optionIds` for a choice field; an empty value clears the field. The write finishes in the request and touches the folder only: to push the new values down a cascading folder run the cascade again with `Overwrite`. The custom text fields are written with `PUT api/2.0/files/metadata/folder/{folderId}/customFields`. The answer is the whole metadata of the folder after the write. A value of the wrong type, a field listed twice, a custom field or a field of a template the folder does not carry is answered with 400; a caller without the right to create in the folder with 403; a folder or a field that does not exist with 404.
|
|
1008
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/set-folder-values/
|
|
1009
|
+
# @param folder_id [Integer] The folder ID.
|
|
1010
|
+
# @param set_metadata_values [SetMetadataValues] The parameters for setting values.
|
|
1011
|
+
# @param [Hash] opts the optional parameters
|
|
1012
|
+
# @return [EntryMetadataWrapper]
|
|
1013
|
+
def set_folder_values(folder_id, set_metadata_values, opts = {})
|
|
1014
|
+
data, _status_code, _headers = set_folder_values_with_http_info(folder_id, set_metadata_values, opts)
|
|
1015
|
+
data
|
|
1016
|
+
end
|
|
1017
|
+
|
|
1018
|
+
# Set folder metadata values
|
|
1019
|
+
# Writes the values of metadata fields on a folder or a room. The caller needs the right to create in the folder (a room manager or a content creator); for a room that is its manager. Every field must belong to a template the folder carries, assigned with `PUT api/2.0/files/metadata/folder/{folderId}/templates` or inherited from a cascading folder, and a field may be listed once. A value carries exactly the member of its type: `stringValue` for a text field of at most 8000 characters, `numberValue` for a number, `dateValue` for a date, `optionIds` for a choice field; an empty value clears the field. The write finishes in the request and touches the folder only: to push the new values down a cascading folder run the cascade again with `Overwrite`. The custom text fields are written with `PUT api/2.0/files/metadata/folder/{folderId}/customFields`. The answer is the whole metadata of the folder after the write. A value of the wrong type, a field listed twice, a custom field or a field of a template the folder does not carry is answered with 400; a caller without the right to create in the folder with 403; a folder or a field that does not exist with 404.
|
|
1020
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/set-folder-values/
|
|
1021
|
+
# @param folder_id [Integer] The folder ID.
|
|
1022
|
+
# @param set_metadata_values [SetMetadataValues] The parameters for setting values.
|
|
1023
|
+
# @param [Hash] opts the optional parameters
|
|
1024
|
+
# @return [Array<(EntryMetadataWrapper, Integer, Hash)>] EntryMetadataWrapper data, response status code and response headers
|
|
1025
|
+
def set_folder_values_with_http_info(folder_id, set_metadata_values, opts = {})
|
|
1026
|
+
if @api_client.config.debugging
|
|
1027
|
+
@api_client.config.logger.debug 'Calling API: Files::MetadataApi.set_folder_values ...'
|
|
1028
|
+
end
|
|
1029
|
+
# verify the required parameter 'folder_id' is set
|
|
1030
|
+
if @api_client.config.client_side_validation && folder_id.nil?
|
|
1031
|
+
fail ArgumentError, "Missing the required parameter 'folder_id' when calling Files::MetadataApi.set_folder_values"
|
|
1032
|
+
end
|
|
1033
|
+
# verify the required parameter 'set_metadata_values' is set
|
|
1034
|
+
if @api_client.config.client_side_validation && set_metadata_values.nil?
|
|
1035
|
+
fail ArgumentError, "Missing the required parameter 'set_metadata_values' when calling Files::MetadataApi.set_folder_values"
|
|
1036
|
+
end
|
|
1037
|
+
# resource path
|
|
1038
|
+
local_var_path = '/api/2.0/files/metadata/folder/{folderId}/values'.sub('{' + 'folderId' + '}', CGI.escape(folder_id.to_s))
|
|
1039
|
+
|
|
1040
|
+
# query parameters
|
|
1041
|
+
query_params = opts[:query_params] || {}
|
|
1042
|
+
|
|
1043
|
+
# header parameters
|
|
1044
|
+
header_params = opts[:header_params] || {}
|
|
1045
|
+
# HTTP header 'Accept' (if needed)
|
|
1046
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1047
|
+
# HTTP header 'Content-Type'
|
|
1048
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
1049
|
+
if !content_type.nil?
|
|
1050
|
+
header_params['Content-Type'] = content_type
|
|
1051
|
+
end
|
|
1052
|
+
|
|
1053
|
+
# form parameters
|
|
1054
|
+
form_params = opts[:form_params] || {}
|
|
1055
|
+
|
|
1056
|
+
# http body (model)
|
|
1057
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(set_metadata_values)
|
|
1058
|
+
|
|
1059
|
+
# return_type
|
|
1060
|
+
return_type = opts[:debug_return_type] || 'EntryMetadataWrapper'
|
|
1061
|
+
|
|
1062
|
+
# auth_names
|
|
1063
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
1064
|
+
|
|
1065
|
+
new_options = opts.merge(
|
|
1066
|
+
:operation => :"Files::MetadataApi.set_folder_values",
|
|
1067
|
+
:header_params => header_params,
|
|
1068
|
+
:query_params => query_params,
|
|
1069
|
+
:form_params => form_params,
|
|
1070
|
+
:body => post_body,
|
|
1071
|
+
:auth_names => auth_names,
|
|
1072
|
+
:return_type => return_type
|
|
1073
|
+
)
|
|
1074
|
+
|
|
1075
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
1076
|
+
if @api_client.config.debugging
|
|
1077
|
+
@api_client.config.logger.debug "API called: Files::MetadataApi#set_folder_values\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1078
|
+
end
|
|
1079
|
+
return data, status_code, headers
|
|
1080
|
+
end
|
|
1081
|
+
|
|
1082
|
+
# Unassign a template from a file
|
|
1083
|
+
# Removes a metadata template from a file together with the values of its fields. The caller needs the right to edit the file. The removal is irreversible for the values, the template itself stays on the portal and on the other entries. It applies to a directly assigned template and to one inherited from a cascading folder alike; a later cascade from that folder assigns it again. A file the caller cannot edit is answered with 403; a file, or a template, that does not exist with 404.
|
|
1084
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/unassign-file-template/
|
|
1085
|
+
# @param file_id [Integer] The file ID.
|
|
1086
|
+
# @param template_id [Integer] The template ID.
|
|
1087
|
+
# @param [Hash] opts the optional parameters
|
|
1088
|
+
# @return [nil]
|
|
1089
|
+
def unassign_file_template(file_id, template_id, opts = {})
|
|
1090
|
+
unassign_file_template_with_http_info(file_id, template_id, opts)
|
|
1091
|
+
nil
|
|
1092
|
+
end
|
|
1093
|
+
|
|
1094
|
+
# Unassign a template from a file
|
|
1095
|
+
# Removes a metadata template from a file together with the values of its fields. The caller needs the right to edit the file. The removal is irreversible for the values, the template itself stays on the portal and on the other entries. It applies to a directly assigned template and to one inherited from a cascading folder alike; a later cascade from that folder assigns it again. A file the caller cannot edit is answered with 403; a file, or a template, that does not exist with 404.
|
|
1096
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/unassign-file-template/
|
|
1097
|
+
# @param file_id [Integer] The file ID.
|
|
1098
|
+
# @param template_id [Integer] The template ID.
|
|
1099
|
+
# @param [Hash] opts the optional parameters
|
|
1100
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
1101
|
+
def unassign_file_template_with_http_info(file_id, template_id, opts = {})
|
|
1102
|
+
if @api_client.config.debugging
|
|
1103
|
+
@api_client.config.logger.debug 'Calling API: Files::MetadataApi.unassign_file_template ...'
|
|
1104
|
+
end
|
|
1105
|
+
# verify the required parameter 'file_id' is set
|
|
1106
|
+
if @api_client.config.client_side_validation && file_id.nil?
|
|
1107
|
+
fail ArgumentError, "Missing the required parameter 'file_id' when calling Files::MetadataApi.unassign_file_template"
|
|
1108
|
+
end
|
|
1109
|
+
# verify the required parameter 'template_id' is set
|
|
1110
|
+
if @api_client.config.client_side_validation && template_id.nil?
|
|
1111
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling Files::MetadataApi.unassign_file_template"
|
|
1112
|
+
end
|
|
1113
|
+
# resource path
|
|
1114
|
+
local_var_path = '/api/2.0/files/metadata/file/{fileId}/templates/{templateId}'.sub('{' + 'fileId' + '}', CGI.escape(file_id.to_s)).sub('{' + 'templateId' + '}', CGI.escape(template_id.to_s))
|
|
1115
|
+
|
|
1116
|
+
# query parameters
|
|
1117
|
+
query_params = opts[:query_params] || {}
|
|
1118
|
+
|
|
1119
|
+
# header parameters
|
|
1120
|
+
header_params = opts[:header_params] || {}
|
|
1121
|
+
# HTTP header 'Accept' (if needed)
|
|
1122
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1123
|
+
|
|
1124
|
+
# form parameters
|
|
1125
|
+
form_params = opts[:form_params] || {}
|
|
1126
|
+
|
|
1127
|
+
# http body (model)
|
|
1128
|
+
post_body = opts[:debug_body]
|
|
1129
|
+
|
|
1130
|
+
# return_type
|
|
1131
|
+
return_type = opts[:debug_return_type]
|
|
1132
|
+
|
|
1133
|
+
# auth_names
|
|
1134
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
1135
|
+
|
|
1136
|
+
new_options = opts.merge(
|
|
1137
|
+
:operation => :"Files::MetadataApi.unassign_file_template",
|
|
1138
|
+
:header_params => header_params,
|
|
1139
|
+
:query_params => query_params,
|
|
1140
|
+
:form_params => form_params,
|
|
1141
|
+
:body => post_body,
|
|
1142
|
+
:auth_names => auth_names,
|
|
1143
|
+
:return_type => return_type
|
|
1144
|
+
)
|
|
1145
|
+
|
|
1146
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
1147
|
+
if @api_client.config.debugging
|
|
1148
|
+
@api_client.config.logger.debug "API called: Files::MetadataApi#unassign_file_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1149
|
+
end
|
|
1150
|
+
return data, status_code, headers
|
|
1151
|
+
end
|
|
1152
|
+
|
|
1153
|
+
# Unassign a template from a folder
|
|
1154
|
+
# Removes a metadata template from a folder or a room together with the values of its fields. The caller needs the right to create content in the folder, that is a room manager or a content creator; for a room that is its manager. When the template was cascaded from this folder, the cascade stops here: the folders and files below keep the template and their values as a direct assignment of their own, and there is no bulk rollback. To take the template off them as well, remove it entry by entry with `DELETE api/2.0/files/metadata/file/{fileId}/templates/{templateId}`. A pass of the cascade still running is stopped for this template. To stop the cascade and keep the template and its values on the folder use `PUT api/2.0/files/metadata/folder/{folderId}/templates/{templateId}` with `cascade` false instead. A caller without the right to create in the folder is answered with 403; a folder, or a template, that does not exist with 404.
|
|
1155
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/unassign-folder-template/
|
|
1156
|
+
# @param folder_id [Integer] The folder ID.
|
|
1157
|
+
# @param template_id [Integer] The template ID.
|
|
1158
|
+
# @param [Hash] opts the optional parameters
|
|
1159
|
+
# @return [nil]
|
|
1160
|
+
def unassign_folder_template(folder_id, template_id, opts = {})
|
|
1161
|
+
unassign_folder_template_with_http_info(folder_id, template_id, opts)
|
|
1162
|
+
nil
|
|
1163
|
+
end
|
|
1164
|
+
|
|
1165
|
+
# Unassign a template from a folder
|
|
1166
|
+
# Removes a metadata template from a folder or a room together with the values of its fields. The caller needs the right to create content in the folder, that is a room manager or a content creator; for a room that is its manager. When the template was cascaded from this folder, the cascade stops here: the folders and files below keep the template and their values as a direct assignment of their own, and there is no bulk rollback. To take the template off them as well, remove it entry by entry with `DELETE api/2.0/files/metadata/file/{fileId}/templates/{templateId}`. A pass of the cascade still running is stopped for this template. To stop the cascade and keep the template and its values on the folder use `PUT api/2.0/files/metadata/folder/{folderId}/templates/{templateId}` with `cascade` false instead. A caller without the right to create in the folder is answered with 403; a folder, or a template, that does not exist with 404.
|
|
1167
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/unassign-folder-template/
|
|
1168
|
+
# @param folder_id [Integer] The folder ID.
|
|
1169
|
+
# @param template_id [Integer] The template ID.
|
|
1170
|
+
# @param [Hash] opts the optional parameters
|
|
1171
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
1172
|
+
def unassign_folder_template_with_http_info(folder_id, template_id, opts = {})
|
|
1173
|
+
if @api_client.config.debugging
|
|
1174
|
+
@api_client.config.logger.debug 'Calling API: Files::MetadataApi.unassign_folder_template ...'
|
|
1175
|
+
end
|
|
1176
|
+
# verify the required parameter 'folder_id' is set
|
|
1177
|
+
if @api_client.config.client_side_validation && folder_id.nil?
|
|
1178
|
+
fail ArgumentError, "Missing the required parameter 'folder_id' when calling Files::MetadataApi.unassign_folder_template"
|
|
1179
|
+
end
|
|
1180
|
+
# verify the required parameter 'template_id' is set
|
|
1181
|
+
if @api_client.config.client_side_validation && template_id.nil?
|
|
1182
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling Files::MetadataApi.unassign_folder_template"
|
|
1183
|
+
end
|
|
1184
|
+
# resource path
|
|
1185
|
+
local_var_path = '/api/2.0/files/metadata/folder/{folderId}/templates/{templateId}'.sub('{' + 'folderId' + '}', CGI.escape(folder_id.to_s)).sub('{' + 'templateId' + '}', CGI.escape(template_id.to_s))
|
|
1186
|
+
|
|
1187
|
+
# query parameters
|
|
1188
|
+
query_params = opts[:query_params] || {}
|
|
1189
|
+
|
|
1190
|
+
# header parameters
|
|
1191
|
+
header_params = opts[:header_params] || {}
|
|
1192
|
+
# HTTP header 'Accept' (if needed)
|
|
1193
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1194
|
+
|
|
1195
|
+
# form parameters
|
|
1196
|
+
form_params = opts[:form_params] || {}
|
|
1197
|
+
|
|
1198
|
+
# http body (model)
|
|
1199
|
+
post_body = opts[:debug_body]
|
|
1200
|
+
|
|
1201
|
+
# return_type
|
|
1202
|
+
return_type = opts[:debug_return_type]
|
|
1203
|
+
|
|
1204
|
+
# auth_names
|
|
1205
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
1206
|
+
|
|
1207
|
+
new_options = opts.merge(
|
|
1208
|
+
:operation => :"Files::MetadataApi.unassign_folder_template",
|
|
1209
|
+
:header_params => header_params,
|
|
1210
|
+
:query_params => query_params,
|
|
1211
|
+
:form_params => form_params,
|
|
1212
|
+
:body => post_body,
|
|
1213
|
+
:auth_names => auth_names,
|
|
1214
|
+
:return_type => return_type
|
|
1215
|
+
)
|
|
1216
|
+
|
|
1217
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
1218
|
+
if @api_client.config.debugging
|
|
1219
|
+
@api_client.config.logger.debug "API called: Files::MetadataApi#unassign_folder_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1220
|
+
end
|
|
1221
|
+
return data, status_code, headers
|
|
1222
|
+
end
|
|
1223
|
+
|
|
1224
|
+
# Update a metadata field
|
|
1225
|
+
# Changes the name, the type, the options or the display order of a metadata field. Only a DocSpace admin can change templates. The request is partial: a property left out keeps its value. The type can be changed only while no entry holds a value for the field, and an option can be removed only while no entry has selected it; a new option is sent without an identifier and gets one in the answer. A new name must be unique within the template regardless of case. The values already written are left as they are. The field is addressed through its own template: a field reached through another template's route is answered with 404, the same as a field that does not exist. A conflicting name, a type change on a field with values or the removal of an option in use is answered with 400.
|
|
1226
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/update-field/
|
|
1227
|
+
# @param template_id [Integer] The template ID.
|
|
1228
|
+
# @param field_id [Integer] The field ID.
|
|
1229
|
+
# @param update_metadata_field_request [UpdateMetadataFieldRequest] The parameters of the field update.
|
|
1230
|
+
# @param [Hash] opts the optional parameters
|
|
1231
|
+
# @return [MetadataFieldWrapper]
|
|
1232
|
+
def update_field(template_id, field_id, update_metadata_field_request, opts = {})
|
|
1233
|
+
data, _status_code, _headers = update_field_with_http_info(template_id, field_id, update_metadata_field_request, opts)
|
|
1234
|
+
data
|
|
1235
|
+
end
|
|
1236
|
+
|
|
1237
|
+
# Update a metadata field
|
|
1238
|
+
# Changes the name, the type, the options or the display order of a metadata field. Only a DocSpace admin can change templates. The request is partial: a property left out keeps its value. The type can be changed only while no entry holds a value for the field, and an option can be removed only while no entry has selected it; a new option is sent without an identifier and gets one in the answer. A new name must be unique within the template regardless of case. The values already written are left as they are. The field is addressed through its own template: a field reached through another template's route is answered with 404, the same as a field that does not exist. A conflicting name, a type change on a field with values or the removal of an option in use is answered with 400.
|
|
1239
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/update-field/
|
|
1240
|
+
# @param template_id [Integer] The template ID.
|
|
1241
|
+
# @param field_id [Integer] The field ID.
|
|
1242
|
+
# @param update_metadata_field_request [UpdateMetadataFieldRequest] The parameters of the field update.
|
|
1243
|
+
# @param [Hash] opts the optional parameters
|
|
1244
|
+
# @return [Array<(MetadataFieldWrapper, Integer, Hash)>] MetadataFieldWrapper data, response status code and response headers
|
|
1245
|
+
def update_field_with_http_info(template_id, field_id, update_metadata_field_request, opts = {})
|
|
1246
|
+
if @api_client.config.debugging
|
|
1247
|
+
@api_client.config.logger.debug 'Calling API: Files::MetadataApi.update_field ...'
|
|
1248
|
+
end
|
|
1249
|
+
# verify the required parameter 'template_id' is set
|
|
1250
|
+
if @api_client.config.client_side_validation && template_id.nil?
|
|
1251
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling Files::MetadataApi.update_field"
|
|
1252
|
+
end
|
|
1253
|
+
# verify the required parameter 'field_id' is set
|
|
1254
|
+
if @api_client.config.client_side_validation && field_id.nil?
|
|
1255
|
+
fail ArgumentError, "Missing the required parameter 'field_id' when calling Files::MetadataApi.update_field"
|
|
1256
|
+
end
|
|
1257
|
+
# verify the required parameter 'update_metadata_field_request' is set
|
|
1258
|
+
if @api_client.config.client_side_validation && update_metadata_field_request.nil?
|
|
1259
|
+
fail ArgumentError, "Missing the required parameter 'update_metadata_field_request' when calling Files::MetadataApi.update_field"
|
|
1260
|
+
end
|
|
1261
|
+
# resource path
|
|
1262
|
+
local_var_path = '/api/2.0/files/metadata/templates/{templateId}/fields/{fieldId}'.sub('{' + 'templateId' + '}', CGI.escape(template_id.to_s)).sub('{' + 'fieldId' + '}', CGI.escape(field_id.to_s))
|
|
1263
|
+
|
|
1264
|
+
# query parameters
|
|
1265
|
+
query_params = opts[:query_params] || {}
|
|
1266
|
+
|
|
1267
|
+
# header parameters
|
|
1268
|
+
header_params = opts[:header_params] || {}
|
|
1269
|
+
# HTTP header 'Accept' (if needed)
|
|
1270
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1271
|
+
# HTTP header 'Content-Type'
|
|
1272
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
1273
|
+
if !content_type.nil?
|
|
1274
|
+
header_params['Content-Type'] = content_type
|
|
1275
|
+
end
|
|
1276
|
+
|
|
1277
|
+
# form parameters
|
|
1278
|
+
form_params = opts[:form_params] || {}
|
|
1279
|
+
|
|
1280
|
+
# http body (model)
|
|
1281
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(update_metadata_field_request)
|
|
1282
|
+
|
|
1283
|
+
# return_type
|
|
1284
|
+
return_type = opts[:debug_return_type] || 'MetadataFieldWrapper'
|
|
1285
|
+
|
|
1286
|
+
# auth_names
|
|
1287
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
1288
|
+
|
|
1289
|
+
new_options = opts.merge(
|
|
1290
|
+
:operation => :"Files::MetadataApi.update_field",
|
|
1291
|
+
:header_params => header_params,
|
|
1292
|
+
:query_params => query_params,
|
|
1293
|
+
:form_params => form_params,
|
|
1294
|
+
:body => post_body,
|
|
1295
|
+
:auth_names => auth_names,
|
|
1296
|
+
:return_type => return_type
|
|
1297
|
+
)
|
|
1298
|
+
|
|
1299
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
1300
|
+
if @api_client.config.debugging
|
|
1301
|
+
@api_client.config.logger.debug "API called: Files::MetadataApi#update_field\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1302
|
+
end
|
|
1303
|
+
return data, status_code, headers
|
|
1304
|
+
end
|
|
1305
|
+
|
|
1306
|
+
# Update a template assignment on a folder
|
|
1307
|
+
# Turns the cascade of a metadata template the folder or the room already carries on or off, without taking the template off the folder. The template must be assigned first, with `PUT api/2.0/files/metadata/folder/{folderId}/templates` or inherited from a folder above. The caller needs the right to create in the folder (a room manager or a content creator); for a room that is its manager. With `cascade` true the template is marked as cascading with the given `conflictResolveType`, an inherited assignment becomes the folder's own, and the pass the assignment runs is queued, also when the cascade was already on: the answer is that pass, poll `GET api/2.0/files/metadata/folder/{folderId}/templates/progress` until `isCompleted` is true. With `cascade` false the folder keeps the template and its values, the entries below keep them as their own, entries created later no longer inherit the template from this folder, a running pass stops at its next batch, and the answer is a completed operation without an identifier; `conflictResolveType` is ignored and a cascade already off stays so. A caller without the right to create in the folder is answered with 403; a folder or a template that does not exist, or a template the folder does not carry, with 404.
|
|
1308
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/update-folder-template/
|
|
1309
|
+
# @param folder_id [Integer] The folder ID.
|
|
1310
|
+
# @param template_id [Integer] The ID of a template the folder already carries.
|
|
1311
|
+
# @param update_folder_metadata_template_request [UpdateFolderMetadataTemplateRequest] The new state of the assignment.
|
|
1312
|
+
# @param [Hash] opts the optional parameters
|
|
1313
|
+
# @return [MetadataOperationWrapper]
|
|
1314
|
+
def update_folder_template(folder_id, template_id, update_folder_metadata_template_request, opts = {})
|
|
1315
|
+
data, _status_code, _headers = update_folder_template_with_http_info(folder_id, template_id, update_folder_metadata_template_request, opts)
|
|
1316
|
+
data
|
|
1317
|
+
end
|
|
1318
|
+
|
|
1319
|
+
# Update a template assignment on a folder
|
|
1320
|
+
# Turns the cascade of a metadata template the folder or the room already carries on or off, without taking the template off the folder. The template must be assigned first, with `PUT api/2.0/files/metadata/folder/{folderId}/templates` or inherited from a folder above. The caller needs the right to create in the folder (a room manager or a content creator); for a room that is its manager. With `cascade` true the template is marked as cascading with the given `conflictResolveType`, an inherited assignment becomes the folder's own, and the pass the assignment runs is queued, also when the cascade was already on: the answer is that pass, poll `GET api/2.0/files/metadata/folder/{folderId}/templates/progress` until `isCompleted` is true. With `cascade` false the folder keeps the template and its values, the entries below keep them as their own, entries created later no longer inherit the template from this folder, a running pass stops at its next batch, and the answer is a completed operation without an identifier; `conflictResolveType` is ignored and a cascade already off stays so. A caller without the right to create in the folder is answered with 403; a folder or a template that does not exist, or a template the folder does not carry, with 404.
|
|
1321
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/update-folder-template/
|
|
1322
|
+
# @param folder_id [Integer] The folder ID.
|
|
1323
|
+
# @param template_id [Integer] The ID of a template the folder already carries.
|
|
1324
|
+
# @param update_folder_metadata_template_request [UpdateFolderMetadataTemplateRequest] The new state of the assignment.
|
|
1325
|
+
# @param [Hash] opts the optional parameters
|
|
1326
|
+
# @return [Array<(MetadataOperationWrapper, Integer, Hash)>] MetadataOperationWrapper data, response status code and response headers
|
|
1327
|
+
def update_folder_template_with_http_info(folder_id, template_id, update_folder_metadata_template_request, opts = {})
|
|
1328
|
+
if @api_client.config.debugging
|
|
1329
|
+
@api_client.config.logger.debug 'Calling API: Files::MetadataApi.update_folder_template ...'
|
|
1330
|
+
end
|
|
1331
|
+
# verify the required parameter 'folder_id' is set
|
|
1332
|
+
if @api_client.config.client_side_validation && folder_id.nil?
|
|
1333
|
+
fail ArgumentError, "Missing the required parameter 'folder_id' when calling Files::MetadataApi.update_folder_template"
|
|
1334
|
+
end
|
|
1335
|
+
# verify the required parameter 'template_id' is set
|
|
1336
|
+
if @api_client.config.client_side_validation && template_id.nil?
|
|
1337
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling Files::MetadataApi.update_folder_template"
|
|
1338
|
+
end
|
|
1339
|
+
# verify the required parameter 'update_folder_metadata_template_request' is set
|
|
1340
|
+
if @api_client.config.client_side_validation && update_folder_metadata_template_request.nil?
|
|
1341
|
+
fail ArgumentError, "Missing the required parameter 'update_folder_metadata_template_request' when calling Files::MetadataApi.update_folder_template"
|
|
1342
|
+
end
|
|
1343
|
+
# resource path
|
|
1344
|
+
local_var_path = '/api/2.0/files/metadata/folder/{folderId}/templates/{templateId}'.sub('{' + 'folderId' + '}', CGI.escape(folder_id.to_s)).sub('{' + 'templateId' + '}', CGI.escape(template_id.to_s))
|
|
1345
|
+
|
|
1346
|
+
# query parameters
|
|
1347
|
+
query_params = opts[:query_params] || {}
|
|
1348
|
+
|
|
1349
|
+
# header parameters
|
|
1350
|
+
header_params = opts[:header_params] || {}
|
|
1351
|
+
# HTTP header 'Accept' (if needed)
|
|
1352
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1353
|
+
# HTTP header 'Content-Type'
|
|
1354
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
1355
|
+
if !content_type.nil?
|
|
1356
|
+
header_params['Content-Type'] = content_type
|
|
1357
|
+
end
|
|
1358
|
+
|
|
1359
|
+
# form parameters
|
|
1360
|
+
form_params = opts[:form_params] || {}
|
|
1361
|
+
|
|
1362
|
+
# http body (model)
|
|
1363
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(update_folder_metadata_template_request)
|
|
1364
|
+
|
|
1365
|
+
# return_type
|
|
1366
|
+
return_type = opts[:debug_return_type] || 'MetadataOperationWrapper'
|
|
1367
|
+
|
|
1368
|
+
# auth_names
|
|
1369
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
1370
|
+
|
|
1371
|
+
new_options = opts.merge(
|
|
1372
|
+
:operation => :"Files::MetadataApi.update_folder_template",
|
|
1373
|
+
:header_params => header_params,
|
|
1374
|
+
:query_params => query_params,
|
|
1375
|
+
:form_params => form_params,
|
|
1376
|
+
:body => post_body,
|
|
1377
|
+
:auth_names => auth_names,
|
|
1378
|
+
:return_type => return_type
|
|
1379
|
+
)
|
|
1380
|
+
|
|
1381
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
1382
|
+
if @api_client.config.debugging
|
|
1383
|
+
@api_client.config.logger.debug "API called: Files::MetadataApi#update_folder_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1384
|
+
end
|
|
1385
|
+
return data, status_code, headers
|
|
1386
|
+
end
|
|
1387
|
+
|
|
1388
|
+
# Update a metadata template
|
|
1389
|
+
# Renames a metadata template or changes whether it is shown in the pickers. Only a DocSpace admin can change templates. The request is partial: a property left out keeps its value, the fields are not touched here and are changed with `PUT api/2.0/files/metadata/templates/{templateId}/fields/{fieldId}`. The new name follows the rules of the creation: unique on the portal regardless of case and at most 255 characters. The answer is the whole template with its fields. A template that does not exist is answered with 404, a name already in use or too long with 400.
|
|
1390
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/update-template/
|
|
1391
|
+
# @param template_id [Integer] The template ID.
|
|
1392
|
+
# @param update_metadata_template [UpdateMetadataTemplate] The parameters for updating the template.
|
|
1393
|
+
# @param [Hash] opts the optional parameters
|
|
1394
|
+
# @return [MetadataTemplateWrapper]
|
|
1395
|
+
def update_template(template_id, update_metadata_template, opts = {})
|
|
1396
|
+
data, _status_code, _headers = update_template_with_http_info(template_id, update_metadata_template, opts)
|
|
1397
|
+
data
|
|
1398
|
+
end
|
|
1399
|
+
|
|
1400
|
+
# Update a metadata template
|
|
1401
|
+
# Renames a metadata template or changes whether it is shown in the pickers. Only a DocSpace admin can change templates. The request is partial: a property left out keeps its value, the fields are not touched here and are changed with `PUT api/2.0/files/metadata/templates/{templateId}/fields/{fieldId}`. The new name follows the rules of the creation: unique on the portal regardless of case and at most 255 characters. The answer is the whole template with its fields. A template that does not exist is answered with 404, a name already in use or too long with 400.
|
|
1402
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/update-template/
|
|
1403
|
+
# @param template_id [Integer] The template ID.
|
|
1404
|
+
# @param update_metadata_template [UpdateMetadataTemplate] The parameters for updating the template.
|
|
1405
|
+
# @param [Hash] opts the optional parameters
|
|
1406
|
+
# @return [Array<(MetadataTemplateWrapper, Integer, Hash)>] MetadataTemplateWrapper data, response status code and response headers
|
|
1407
|
+
def update_template_with_http_info(template_id, update_metadata_template, opts = {})
|
|
1408
|
+
if @api_client.config.debugging
|
|
1409
|
+
@api_client.config.logger.debug 'Calling API: Files::MetadataApi.update_template ...'
|
|
1410
|
+
end
|
|
1411
|
+
# verify the required parameter 'template_id' is set
|
|
1412
|
+
if @api_client.config.client_side_validation && template_id.nil?
|
|
1413
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling Files::MetadataApi.update_template"
|
|
1414
|
+
end
|
|
1415
|
+
# verify the required parameter 'update_metadata_template' is set
|
|
1416
|
+
if @api_client.config.client_side_validation && update_metadata_template.nil?
|
|
1417
|
+
fail ArgumentError, "Missing the required parameter 'update_metadata_template' when calling Files::MetadataApi.update_template"
|
|
1418
|
+
end
|
|
1419
|
+
# resource path
|
|
1420
|
+
local_var_path = '/api/2.0/files/metadata/templates/{templateId}'.sub('{' + 'templateId' + '}', CGI.escape(template_id.to_s))
|
|
1421
|
+
|
|
1422
|
+
# query parameters
|
|
1423
|
+
query_params = opts[:query_params] || {}
|
|
1424
|
+
|
|
1425
|
+
# header parameters
|
|
1426
|
+
header_params = opts[:header_params] || {}
|
|
1427
|
+
# HTTP header 'Accept' (if needed)
|
|
1428
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1429
|
+
# HTTP header 'Content-Type'
|
|
1430
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
1431
|
+
if !content_type.nil?
|
|
1432
|
+
header_params['Content-Type'] = content_type
|
|
1433
|
+
end
|
|
1434
|
+
|
|
1435
|
+
# form parameters
|
|
1436
|
+
form_params = opts[:form_params] || {}
|
|
1437
|
+
|
|
1438
|
+
# http body (model)
|
|
1439
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(update_metadata_template)
|
|
1440
|
+
|
|
1441
|
+
# return_type
|
|
1442
|
+
return_type = opts[:debug_return_type] || 'MetadataTemplateWrapper'
|
|
1443
|
+
|
|
1444
|
+
# auth_names
|
|
1445
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
1446
|
+
|
|
1447
|
+
new_options = opts.merge(
|
|
1448
|
+
:operation => :"Files::MetadataApi.update_template",
|
|
1449
|
+
:header_params => header_params,
|
|
1450
|
+
:query_params => query_params,
|
|
1451
|
+
:form_params => form_params,
|
|
1452
|
+
:body => post_body,
|
|
1453
|
+
:auth_names => auth_names,
|
|
1454
|
+
:return_type => return_type
|
|
1455
|
+
)
|
|
1456
|
+
|
|
1457
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
1458
|
+
if @api_client.config.debugging
|
|
1459
|
+
@api_client.config.logger.debug "API called: Files::MetadataApi#update_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1460
|
+
end
|
|
1461
|
+
return data, status_code, headers
|
|
1462
|
+
end
|
|
1463
|
+
end
|
|
1464
|
+
end
|
|
1465
|
+
end
|