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,1150 @@
|
|
|
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 People
|
|
20
|
+
class SearchApi
|
|
21
|
+
attr_accessor :api_client
|
|
22
|
+
|
|
23
|
+
def initialize(api_client = ApiClient.default)
|
|
24
|
+
@api_client = api_client
|
|
25
|
+
end
|
|
26
|
+
# Search accounts for a file
|
|
27
|
+
# Searches the portal users and groups that can be given access to the file with the ID given in the route, and reports for each of them whether it already has access to that file. The caller has to be allowed to manage the access of that file, and the ID has to belong to an existing file, so the operation answers 403 for a file the caller cannot share and 404 for an ID that matches nothing. The search is read-only and needs `filterValue`: while it is empty the operation returns an empty list and a total of 0 instead of every account, so it cannot be used to enumerate the portal. `filterValue` is matched case-insensitively against the first name, the last name and the email; without `filterSeparator` it is split on spaces and every term has to match, and with a separator it is split on that separator and any term may match. Matching groups are streamed first and users after them, both paged together by `count` and `startIndex`, while the number of matches is reported in the total count of the response. Pass `excludeShared` to keep only the accounts that have no access yet, `includeShared` to keep only those that already have it, and neither to get both kinds with the `shared` field telling them apart.
|
|
28
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-accounts-entries-with-files-shared/
|
|
29
|
+
# @param id [Integer, String] The ID of the room, folder or file whose access the search is run against, taken from the route. It is an integer for an entry stored in DocSpace and a provider-specific string for an entry in a connected third-party storage.
|
|
30
|
+
# @param [Hash] opts the optional parameters
|
|
31
|
+
# @option opts [EmployeeStatus] :employee_status Keeps only the users in the given account state: `Active` for a working account, `Terminated` for a disabled one and `Pending` for one that has not accepted its invitation yet. Omit it to search every state.
|
|
32
|
+
# @option opts [EmployeeActivationStatus] :activation_status Keeps only the users whose activation is in the given state: `NotActivated` for an account that has never been activated, `Activated` for one that completed the activation, `Pending` for one whose invitation is still open, and `AutoGenerated` for an account created by the portal itself. Omit it to search every state.
|
|
33
|
+
# @option opts [Boolean] :exclude_shared Keeps only the accounts that do not have access to the entry yet, which is the set to offer when adding new members. It takes precedence over `includeShared`, and every returned entry has `shared` set to false.
|
|
34
|
+
# @option opts [Boolean] :include_shared Keeps only the accounts that already have access to the entry, which is the set to offer when changing or revoking access. Every returned entry has `shared` set to true, and the flag is ignored when `excludeShared` is also set.
|
|
35
|
+
# @option opts [Boolean] :invited_by_me Keeps only the users invited by the caller when true, and only the users invited by somebody else when false. Omit it to search regardless of who sent the invitation.
|
|
36
|
+
# @option opts [String] :inviter_id Keeps only the users invited by the account with this ID. Omit it to search regardless of who sent the invitation.
|
|
37
|
+
# @option opts [AccountSearchArea] :area The part of the portal to search in: `All`, the default, searches members and guests together, `People` leaves the guests out, and `Guests` returns guests only - and for a caller who is not a DocSpace administrator, only the guests that caller is related to.
|
|
38
|
+
# @option opts [Array<EmployeeType>] :employee_types Keeps only the users of the listed types, combined as alternatives. An empty list, which is the default, searches every type.
|
|
39
|
+
# @option opts [Integer] :count The size of the page, counting groups and users together. It defaults to 100, which is also the largest value the operation accepts.
|
|
40
|
+
# @option opts [Integer] :start_index The number of matches to skip before the page starts, counted over the groups and users together. It defaults to 0, and the total number of matches is reported in the total count of the response.
|
|
41
|
+
# @option opts [String] :filter_separator The character that splits `filterValue` into several terms, of which any one may match. Omit it to split the value on spaces instead, in which case every term has to match.
|
|
42
|
+
# @option opts [String] :filter_value The text to search for, matched case-insensitively against the first name, the last name and the email. It is required in practice: while it is empty the search returns nothing at all rather than every account.
|
|
43
|
+
# @return [AccountEntryArrayWrapper]
|
|
44
|
+
def get_accounts_entries_with_files_shared(id, opts = {})
|
|
45
|
+
data, _status_code, _headers = get_accounts_entries_with_files_shared_with_http_info(id, opts)
|
|
46
|
+
data
|
|
47
|
+
end
|
|
48
|
+
|
|
49
|
+
# Search accounts for a file
|
|
50
|
+
# Searches the portal users and groups that can be given access to the file with the ID given in the route, and reports for each of them whether it already has access to that file. The caller has to be allowed to manage the access of that file, and the ID has to belong to an existing file, so the operation answers 403 for a file the caller cannot share and 404 for an ID that matches nothing. The search is read-only and needs `filterValue`: while it is empty the operation returns an empty list and a total of 0 instead of every account, so it cannot be used to enumerate the portal. `filterValue` is matched case-insensitively against the first name, the last name and the email; without `filterSeparator` it is split on spaces and every term has to match, and with a separator it is split on that separator and any term may match. Matching groups are streamed first and users after them, both paged together by `count` and `startIndex`, while the number of matches is reported in the total count of the response. Pass `excludeShared` to keep only the accounts that have no access yet, `includeShared` to keep only those that already have it, and neither to get both kinds with the `shared` field telling them apart.
|
|
51
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-accounts-entries-with-files-shared/
|
|
52
|
+
# @param id [Integer, String] The ID of the room, folder or file whose access the search is run against, taken from the route. It is an integer for an entry stored in DocSpace and a provider-specific string for an entry in a connected third-party storage.
|
|
53
|
+
# @param [Hash] opts the optional parameters
|
|
54
|
+
# @option opts [EmployeeStatus] :employee_status Keeps only the users in the given account state: `Active` for a working account, `Terminated` for a disabled one and `Pending` for one that has not accepted its invitation yet. Omit it to search every state.
|
|
55
|
+
# @option opts [EmployeeActivationStatus] :activation_status Keeps only the users whose activation is in the given state: `NotActivated` for an account that has never been activated, `Activated` for one that completed the activation, `Pending` for one whose invitation is still open, and `AutoGenerated` for an account created by the portal itself. Omit it to search every state.
|
|
56
|
+
# @option opts [Boolean] :exclude_shared Keeps only the accounts that do not have access to the entry yet, which is the set to offer when adding new members. It takes precedence over `includeShared`, and every returned entry has `shared` set to false.
|
|
57
|
+
# @option opts [Boolean] :include_shared Keeps only the accounts that already have access to the entry, which is the set to offer when changing or revoking access. Every returned entry has `shared` set to true, and the flag is ignored when `excludeShared` is also set.
|
|
58
|
+
# @option opts [Boolean] :invited_by_me Keeps only the users invited by the caller when true, and only the users invited by somebody else when false. Omit it to search regardless of who sent the invitation.
|
|
59
|
+
# @option opts [String] :inviter_id Keeps only the users invited by the account with this ID. Omit it to search regardless of who sent the invitation.
|
|
60
|
+
# @option opts [AccountSearchArea] :area The part of the portal to search in: `All`, the default, searches members and guests together, `People` leaves the guests out, and `Guests` returns guests only - and for a caller who is not a DocSpace administrator, only the guests that caller is related to.
|
|
61
|
+
# @option opts [Array<EmployeeType>] :employee_types Keeps only the users of the listed types, combined as alternatives. An empty list, which is the default, searches every type.
|
|
62
|
+
# @option opts [Integer] :count The size of the page, counting groups and users together. It defaults to 100, which is also the largest value the operation accepts.
|
|
63
|
+
# @option opts [Integer] :start_index The number of matches to skip before the page starts, counted over the groups and users together. It defaults to 0, and the total number of matches is reported in the total count of the response.
|
|
64
|
+
# @option opts [String] :filter_separator The character that splits `filterValue` into several terms, of which any one may match. Omit it to split the value on spaces instead, in which case every term has to match.
|
|
65
|
+
# @option opts [String] :filter_value The text to search for, matched case-insensitively against the first name, the last name and the email. It is required in practice: while it is empty the search returns nothing at all rather than every account.
|
|
66
|
+
# @return [Array<(AccountEntryArrayWrapper, Integer, Hash)>] AccountEntryArrayWrapper data, response status code and response headers
|
|
67
|
+
def get_accounts_entries_with_files_shared_with_http_info(id, opts = {})
|
|
68
|
+
if @api_client.config.debugging
|
|
69
|
+
@api_client.config.logger.debug 'Calling API: People::SearchApi.get_accounts_entries_with_files_shared ...'
|
|
70
|
+
end
|
|
71
|
+
# verify the required parameter 'id' is set
|
|
72
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
73
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling People::SearchApi.get_accounts_entries_with_files_shared"
|
|
74
|
+
end
|
|
75
|
+
if @api_client.config.client_side_validation && !opts[:'count'].nil? && opts[:'count'] > 100
|
|
76
|
+
fail ArgumentError, 'invalid value for "opts[:"count"]" when calling People::SearchApi.get_accounts_entries_with_files_shared, must be smaller than or equal to 100.'
|
|
77
|
+
end
|
|
78
|
+
|
|
79
|
+
if @api_client.config.client_side_validation && !opts[:'count'].nil? && opts[:'count'] < 1
|
|
80
|
+
fail ArgumentError, 'invalid value for "opts[:"count"]" when calling People::SearchApi.get_accounts_entries_with_files_shared, must be greater than or equal to 1.'
|
|
81
|
+
end
|
|
82
|
+
|
|
83
|
+
# resource path
|
|
84
|
+
local_var_path = '/api/2.0/accounts/file/{id}/search'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
85
|
+
|
|
86
|
+
# query parameters
|
|
87
|
+
query_params = opts[:query_params] || {}
|
|
88
|
+
query_params[:'employeeStatus'] = opts[:'employee_status'] if !opts[:'employee_status'].nil?
|
|
89
|
+
query_params[:'activationStatus'] = opts[:'activation_status'] if !opts[:'activation_status'].nil?
|
|
90
|
+
query_params[:'excludeShared'] = opts[:'exclude_shared'] if !opts[:'exclude_shared'].nil?
|
|
91
|
+
query_params[:'includeShared'] = opts[:'include_shared'] if !opts[:'include_shared'].nil?
|
|
92
|
+
query_params[:'invitedByMe'] = opts[:'invited_by_me'] if !opts[:'invited_by_me'].nil?
|
|
93
|
+
query_params[:'inviterId'] = opts[:'inviter_id'] if !opts[:'inviter_id'].nil?
|
|
94
|
+
query_params[:'area'] = opts[:'area'] if !opts[:'area'].nil?
|
|
95
|
+
query_params[:'employeeTypes'] = @api_client.build_collection_param(opts[:'employee_types'], :multi) if !opts[:'employee_types'].nil?
|
|
96
|
+
query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
|
|
97
|
+
query_params[:'startIndex'] = opts[:'start_index'] if !opts[:'start_index'].nil?
|
|
98
|
+
query_params[:'filterSeparator'] = opts[:'filter_separator'] if !opts[:'filter_separator'].nil?
|
|
99
|
+
query_params[:'filterValue'] = opts[:'filter_value'] if !opts[:'filter_value'].nil?
|
|
100
|
+
|
|
101
|
+
# header parameters
|
|
102
|
+
header_params = opts[:header_params] || {}
|
|
103
|
+
# HTTP header 'Accept' (if needed)
|
|
104
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
105
|
+
|
|
106
|
+
# form parameters
|
|
107
|
+
form_params = opts[:form_params] || {}
|
|
108
|
+
|
|
109
|
+
# http body (model)
|
|
110
|
+
post_body = opts[:debug_body]
|
|
111
|
+
|
|
112
|
+
# return_type
|
|
113
|
+
return_type = opts[:debug_return_type] || 'AccountEntryArrayWrapper'
|
|
114
|
+
|
|
115
|
+
# auth_names
|
|
116
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
117
|
+
|
|
118
|
+
new_options = opts.merge(
|
|
119
|
+
:operation => :"People::SearchApi.get_accounts_entries_with_files_shared",
|
|
120
|
+
:header_params => header_params,
|
|
121
|
+
:query_params => query_params,
|
|
122
|
+
:form_params => form_params,
|
|
123
|
+
:body => post_body,
|
|
124
|
+
:auth_names => auth_names,
|
|
125
|
+
:return_type => return_type
|
|
126
|
+
)
|
|
127
|
+
|
|
128
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
129
|
+
if @api_client.config.debugging
|
|
130
|
+
@api_client.config.logger.debug "API called: People::SearchApi#get_accounts_entries_with_files_shared\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
131
|
+
end
|
|
132
|
+
return data, status_code, headers
|
|
133
|
+
end
|
|
134
|
+
|
|
135
|
+
# Search accounts for a folder
|
|
136
|
+
# Searches the portal users and groups that can be given access to the folder with the ID given in the route, and reports for each of them whether it already has access to that folder. The caller has to be allowed to manage the access of that folder, and the ID has to belong to an existing folder, so the operation answers 403 for a folder the caller cannot share and 404 for an ID that matches nothing. The search is read-only and needs `filterValue`: while it is empty the operation returns an empty list and a total of 0 instead of every account, so it cannot be used to enumerate the portal. `filterValue` is matched case-insensitively against the first name, the last name and the email; without `filterSeparator` it is split on spaces and every term has to match, and with a separator it is split on that separator and any term may match. Matching groups are streamed first and users after them, both paged together by `count` and `startIndex`, while the number of matches is reported in the total count of the response. Pass `excludeShared` to keep only the accounts that have no access yet, `includeShared` to keep only those that already have it, and neither to get both kinds with the `shared` field telling them apart.
|
|
137
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-accounts-entries-with-folders-shared/
|
|
138
|
+
# @param id [Integer, String] The ID of the room, folder or file whose access the search is run against, taken from the route. It is an integer for an entry stored in DocSpace and a provider-specific string for an entry in a connected third-party storage.
|
|
139
|
+
# @param [Hash] opts the optional parameters
|
|
140
|
+
# @option opts [EmployeeStatus] :employee_status Keeps only the users in the given account state: `Active` for a working account, `Terminated` for a disabled one and `Pending` for one that has not accepted its invitation yet. Omit it to search every state.
|
|
141
|
+
# @option opts [EmployeeActivationStatus] :activation_status Keeps only the users whose activation is in the given state: `NotActivated` for an account that has never been activated, `Activated` for one that completed the activation, `Pending` for one whose invitation is still open, and `AutoGenerated` for an account created by the portal itself. Omit it to search every state.
|
|
142
|
+
# @option opts [Boolean] :exclude_shared Keeps only the accounts that do not have access to the entry yet, which is the set to offer when adding new members. It takes precedence over `includeShared`, and every returned entry has `shared` set to false.
|
|
143
|
+
# @option opts [Boolean] :include_shared Keeps only the accounts that already have access to the entry, which is the set to offer when changing or revoking access. Every returned entry has `shared` set to true, and the flag is ignored when `excludeShared` is also set.
|
|
144
|
+
# @option opts [Boolean] :invited_by_me Keeps only the users invited by the caller when true, and only the users invited by somebody else when false. Omit it to search regardless of who sent the invitation.
|
|
145
|
+
# @option opts [String] :inviter_id Keeps only the users invited by the account with this ID. Omit it to search regardless of who sent the invitation.
|
|
146
|
+
# @option opts [AccountSearchArea] :area The part of the portal to search in: `All`, the default, searches members and guests together, `People` leaves the guests out, and `Guests` returns guests only - and for a caller who is not a DocSpace administrator, only the guests that caller is related to.
|
|
147
|
+
# @option opts [Array<EmployeeType>] :employee_types Keeps only the users of the listed types, combined as alternatives. An empty list, which is the default, searches every type.
|
|
148
|
+
# @option opts [Integer] :count The size of the page, counting groups and users together. It defaults to 100, which is also the largest value the operation accepts.
|
|
149
|
+
# @option opts [Integer] :start_index The number of matches to skip before the page starts, counted over the groups and users together. It defaults to 0, and the total number of matches is reported in the total count of the response.
|
|
150
|
+
# @option opts [String] :filter_separator The character that splits `filterValue` into several terms, of which any one may match. Omit it to split the value on spaces instead, in which case every term has to match.
|
|
151
|
+
# @option opts [String] :filter_value The text to search for, matched case-insensitively against the first name, the last name and the email. It is required in practice: while it is empty the search returns nothing at all rather than every account.
|
|
152
|
+
# @return [AccountEntryArrayWrapper]
|
|
153
|
+
def get_accounts_entries_with_folders_shared(id, opts = {})
|
|
154
|
+
data, _status_code, _headers = get_accounts_entries_with_folders_shared_with_http_info(id, opts)
|
|
155
|
+
data
|
|
156
|
+
end
|
|
157
|
+
|
|
158
|
+
# Search accounts for a folder
|
|
159
|
+
# Searches the portal users and groups that can be given access to the folder with the ID given in the route, and reports for each of them whether it already has access to that folder. The caller has to be allowed to manage the access of that folder, and the ID has to belong to an existing folder, so the operation answers 403 for a folder the caller cannot share and 404 for an ID that matches nothing. The search is read-only and needs `filterValue`: while it is empty the operation returns an empty list and a total of 0 instead of every account, so it cannot be used to enumerate the portal. `filterValue` is matched case-insensitively against the first name, the last name and the email; without `filterSeparator` it is split on spaces and every term has to match, and with a separator it is split on that separator and any term may match. Matching groups are streamed first and users after them, both paged together by `count` and `startIndex`, while the number of matches is reported in the total count of the response. Pass `excludeShared` to keep only the accounts that have no access yet, `includeShared` to keep only those that already have it, and neither to get both kinds with the `shared` field telling them apart.
|
|
160
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-accounts-entries-with-folders-shared/
|
|
161
|
+
# @param id [Integer, String] The ID of the room, folder or file whose access the search is run against, taken from the route. It is an integer for an entry stored in DocSpace and a provider-specific string for an entry in a connected third-party storage.
|
|
162
|
+
# @param [Hash] opts the optional parameters
|
|
163
|
+
# @option opts [EmployeeStatus] :employee_status Keeps only the users in the given account state: `Active` for a working account, `Terminated` for a disabled one and `Pending` for one that has not accepted its invitation yet. Omit it to search every state.
|
|
164
|
+
# @option opts [EmployeeActivationStatus] :activation_status Keeps only the users whose activation is in the given state: `NotActivated` for an account that has never been activated, `Activated` for one that completed the activation, `Pending` for one whose invitation is still open, and `AutoGenerated` for an account created by the portal itself. Omit it to search every state.
|
|
165
|
+
# @option opts [Boolean] :exclude_shared Keeps only the accounts that do not have access to the entry yet, which is the set to offer when adding new members. It takes precedence over `includeShared`, and every returned entry has `shared` set to false.
|
|
166
|
+
# @option opts [Boolean] :include_shared Keeps only the accounts that already have access to the entry, which is the set to offer when changing or revoking access. Every returned entry has `shared` set to true, and the flag is ignored when `excludeShared` is also set.
|
|
167
|
+
# @option opts [Boolean] :invited_by_me Keeps only the users invited by the caller when true, and only the users invited by somebody else when false. Omit it to search regardless of who sent the invitation.
|
|
168
|
+
# @option opts [String] :inviter_id Keeps only the users invited by the account with this ID. Omit it to search regardless of who sent the invitation.
|
|
169
|
+
# @option opts [AccountSearchArea] :area The part of the portal to search in: `All`, the default, searches members and guests together, `People` leaves the guests out, and `Guests` returns guests only - and for a caller who is not a DocSpace administrator, only the guests that caller is related to.
|
|
170
|
+
# @option opts [Array<EmployeeType>] :employee_types Keeps only the users of the listed types, combined as alternatives. An empty list, which is the default, searches every type.
|
|
171
|
+
# @option opts [Integer] :count The size of the page, counting groups and users together. It defaults to 100, which is also the largest value the operation accepts.
|
|
172
|
+
# @option opts [Integer] :start_index The number of matches to skip before the page starts, counted over the groups and users together. It defaults to 0, and the total number of matches is reported in the total count of the response.
|
|
173
|
+
# @option opts [String] :filter_separator The character that splits `filterValue` into several terms, of which any one may match. Omit it to split the value on spaces instead, in which case every term has to match.
|
|
174
|
+
# @option opts [String] :filter_value The text to search for, matched case-insensitively against the first name, the last name and the email. It is required in practice: while it is empty the search returns nothing at all rather than every account.
|
|
175
|
+
# @return [Array<(AccountEntryArrayWrapper, Integer, Hash)>] AccountEntryArrayWrapper data, response status code and response headers
|
|
176
|
+
def get_accounts_entries_with_folders_shared_with_http_info(id, opts = {})
|
|
177
|
+
if @api_client.config.debugging
|
|
178
|
+
@api_client.config.logger.debug 'Calling API: People::SearchApi.get_accounts_entries_with_folders_shared ...'
|
|
179
|
+
end
|
|
180
|
+
# verify the required parameter 'id' is set
|
|
181
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
182
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling People::SearchApi.get_accounts_entries_with_folders_shared"
|
|
183
|
+
end
|
|
184
|
+
if @api_client.config.client_side_validation && !opts[:'count'].nil? && opts[:'count'] > 100
|
|
185
|
+
fail ArgumentError, 'invalid value for "opts[:"count"]" when calling People::SearchApi.get_accounts_entries_with_folders_shared, must be smaller than or equal to 100.'
|
|
186
|
+
end
|
|
187
|
+
|
|
188
|
+
if @api_client.config.client_side_validation && !opts[:'count'].nil? && opts[:'count'] < 1
|
|
189
|
+
fail ArgumentError, 'invalid value for "opts[:"count"]" when calling People::SearchApi.get_accounts_entries_with_folders_shared, must be greater than or equal to 1.'
|
|
190
|
+
end
|
|
191
|
+
|
|
192
|
+
# resource path
|
|
193
|
+
local_var_path = '/api/2.0/accounts/folder/{id}/search'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
194
|
+
|
|
195
|
+
# query parameters
|
|
196
|
+
query_params = opts[:query_params] || {}
|
|
197
|
+
query_params[:'employeeStatus'] = opts[:'employee_status'] if !opts[:'employee_status'].nil?
|
|
198
|
+
query_params[:'activationStatus'] = opts[:'activation_status'] if !opts[:'activation_status'].nil?
|
|
199
|
+
query_params[:'excludeShared'] = opts[:'exclude_shared'] if !opts[:'exclude_shared'].nil?
|
|
200
|
+
query_params[:'includeShared'] = opts[:'include_shared'] if !opts[:'include_shared'].nil?
|
|
201
|
+
query_params[:'invitedByMe'] = opts[:'invited_by_me'] if !opts[:'invited_by_me'].nil?
|
|
202
|
+
query_params[:'inviterId'] = opts[:'inviter_id'] if !opts[:'inviter_id'].nil?
|
|
203
|
+
query_params[:'area'] = opts[:'area'] if !opts[:'area'].nil?
|
|
204
|
+
query_params[:'employeeTypes'] = @api_client.build_collection_param(opts[:'employee_types'], :multi) if !opts[:'employee_types'].nil?
|
|
205
|
+
query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
|
|
206
|
+
query_params[:'startIndex'] = opts[:'start_index'] if !opts[:'start_index'].nil?
|
|
207
|
+
query_params[:'filterSeparator'] = opts[:'filter_separator'] if !opts[:'filter_separator'].nil?
|
|
208
|
+
query_params[:'filterValue'] = opts[:'filter_value'] if !opts[:'filter_value'].nil?
|
|
209
|
+
|
|
210
|
+
# header parameters
|
|
211
|
+
header_params = opts[:header_params] || {}
|
|
212
|
+
# HTTP header 'Accept' (if needed)
|
|
213
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
214
|
+
|
|
215
|
+
# form parameters
|
|
216
|
+
form_params = opts[:form_params] || {}
|
|
217
|
+
|
|
218
|
+
# http body (model)
|
|
219
|
+
post_body = opts[:debug_body]
|
|
220
|
+
|
|
221
|
+
# return_type
|
|
222
|
+
return_type = opts[:debug_return_type] || 'AccountEntryArrayWrapper'
|
|
223
|
+
|
|
224
|
+
# auth_names
|
|
225
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
226
|
+
|
|
227
|
+
new_options = opts.merge(
|
|
228
|
+
:operation => :"People::SearchApi.get_accounts_entries_with_folders_shared",
|
|
229
|
+
:header_params => header_params,
|
|
230
|
+
:query_params => query_params,
|
|
231
|
+
:form_params => form_params,
|
|
232
|
+
:body => post_body,
|
|
233
|
+
:auth_names => auth_names,
|
|
234
|
+
:return_type => return_type
|
|
235
|
+
)
|
|
236
|
+
|
|
237
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
238
|
+
if @api_client.config.debugging
|
|
239
|
+
@api_client.config.logger.debug "API called: People::SearchApi#get_accounts_entries_with_folders_shared\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
240
|
+
end
|
|
241
|
+
return data, status_code, headers
|
|
242
|
+
end
|
|
243
|
+
|
|
244
|
+
# Search accounts for a room
|
|
245
|
+
# Searches the portal users and groups that can be given access to the room with the ID given in the route, and reports for each of them whether it already has access to that room. The caller has to be allowed to manage the access of that room, and the ID has to belong to an existing room, so the operation answers 403 for a room the caller cannot share and 404 for an ID that matches nothing. The search is read-only and needs `filterValue`: while it is empty the operation returns an empty list and a total of 0 instead of every account, so it cannot be used to enumerate the portal. `filterValue` is matched case-insensitively against the first name, the last name and the email; without `filterSeparator` it is split on spaces and every term has to match, and with a separator it is split on that separator and any term may match. Matching groups are streamed first and users after them, both paged together by `count` and `startIndex`, while the number of matches is reported in the total count of the response. Pass `excludeShared` to keep only the accounts that have no access yet, `includeShared` to keep only those that already have it, and neither to get both kinds with the `shared` field telling them apart.
|
|
246
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-accounts-entries-with-rooms-shared/
|
|
247
|
+
# @param id [Integer, String] The ID of the room, folder or file whose access the search is run against, taken from the route. It is an integer for an entry stored in DocSpace and a provider-specific string for an entry in a connected third-party storage.
|
|
248
|
+
# @param [Hash] opts the optional parameters
|
|
249
|
+
# @option opts [EmployeeStatus] :employee_status Keeps only the users in the given account state: `Active` for a working account, `Terminated` for a disabled one and `Pending` for one that has not accepted its invitation yet. Omit it to search every state.
|
|
250
|
+
# @option opts [EmployeeActivationStatus] :activation_status Keeps only the users whose activation is in the given state: `NotActivated` for an account that has never been activated, `Activated` for one that completed the activation, `Pending` for one whose invitation is still open, and `AutoGenerated` for an account created by the portal itself. Omit it to search every state.
|
|
251
|
+
# @option opts [Boolean] :exclude_shared Keeps only the accounts that do not have access to the entry yet, which is the set to offer when adding new members. It takes precedence over `includeShared`, and every returned entry has `shared` set to false.
|
|
252
|
+
# @option opts [Boolean] :include_shared Keeps only the accounts that already have access to the entry, which is the set to offer when changing or revoking access. Every returned entry has `shared` set to true, and the flag is ignored when `excludeShared` is also set.
|
|
253
|
+
# @option opts [Boolean] :invited_by_me Keeps only the users invited by the caller when true, and only the users invited by somebody else when false. Omit it to search regardless of who sent the invitation.
|
|
254
|
+
# @option opts [String] :inviter_id Keeps only the users invited by the account with this ID. Omit it to search regardless of who sent the invitation.
|
|
255
|
+
# @option opts [AccountSearchArea] :area The part of the portal to search in: `All`, the default, searches members and guests together, `People` leaves the guests out, and `Guests` returns guests only - and for a caller who is not a DocSpace administrator, only the guests that caller is related to.
|
|
256
|
+
# @option opts [Array<EmployeeType>] :employee_types Keeps only the users of the listed types, combined as alternatives. An empty list, which is the default, searches every type.
|
|
257
|
+
# @option opts [Integer] :count The size of the page, counting groups and users together. It defaults to 100, which is also the largest value the operation accepts.
|
|
258
|
+
# @option opts [Integer] :start_index The number of matches to skip before the page starts, counted over the groups and users together. It defaults to 0, and the total number of matches is reported in the total count of the response.
|
|
259
|
+
# @option opts [String] :filter_separator The character that splits `filterValue` into several terms, of which any one may match. Omit it to split the value on spaces instead, in which case every term has to match.
|
|
260
|
+
# @option opts [String] :filter_value The text to search for, matched case-insensitively against the first name, the last name and the email. It is required in practice: while it is empty the search returns nothing at all rather than every account.
|
|
261
|
+
# @return [AccountEntryArrayWrapper]
|
|
262
|
+
def get_accounts_entries_with_rooms_shared(id, opts = {})
|
|
263
|
+
data, _status_code, _headers = get_accounts_entries_with_rooms_shared_with_http_info(id, opts)
|
|
264
|
+
data
|
|
265
|
+
end
|
|
266
|
+
|
|
267
|
+
# Search accounts for a room
|
|
268
|
+
# Searches the portal users and groups that can be given access to the room with the ID given in the route, and reports for each of them whether it already has access to that room. The caller has to be allowed to manage the access of that room, and the ID has to belong to an existing room, so the operation answers 403 for a room the caller cannot share and 404 for an ID that matches nothing. The search is read-only and needs `filterValue`: while it is empty the operation returns an empty list and a total of 0 instead of every account, so it cannot be used to enumerate the portal. `filterValue` is matched case-insensitively against the first name, the last name and the email; without `filterSeparator` it is split on spaces and every term has to match, and with a separator it is split on that separator and any term may match. Matching groups are streamed first and users after them, both paged together by `count` and `startIndex`, while the number of matches is reported in the total count of the response. Pass `excludeShared` to keep only the accounts that have no access yet, `includeShared` to keep only those that already have it, and neither to get both kinds with the `shared` field telling them apart.
|
|
269
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-accounts-entries-with-rooms-shared/
|
|
270
|
+
# @param id [Integer, String] The ID of the room, folder or file whose access the search is run against, taken from the route. It is an integer for an entry stored in DocSpace and a provider-specific string for an entry in a connected third-party storage.
|
|
271
|
+
# @param [Hash] opts the optional parameters
|
|
272
|
+
# @option opts [EmployeeStatus] :employee_status Keeps only the users in the given account state: `Active` for a working account, `Terminated` for a disabled one and `Pending` for one that has not accepted its invitation yet. Omit it to search every state.
|
|
273
|
+
# @option opts [EmployeeActivationStatus] :activation_status Keeps only the users whose activation is in the given state: `NotActivated` for an account that has never been activated, `Activated` for one that completed the activation, `Pending` for one whose invitation is still open, and `AutoGenerated` for an account created by the portal itself. Omit it to search every state.
|
|
274
|
+
# @option opts [Boolean] :exclude_shared Keeps only the accounts that do not have access to the entry yet, which is the set to offer when adding new members. It takes precedence over `includeShared`, and every returned entry has `shared` set to false.
|
|
275
|
+
# @option opts [Boolean] :include_shared Keeps only the accounts that already have access to the entry, which is the set to offer when changing or revoking access. Every returned entry has `shared` set to true, and the flag is ignored when `excludeShared` is also set.
|
|
276
|
+
# @option opts [Boolean] :invited_by_me Keeps only the users invited by the caller when true, and only the users invited by somebody else when false. Omit it to search regardless of who sent the invitation.
|
|
277
|
+
# @option opts [String] :inviter_id Keeps only the users invited by the account with this ID. Omit it to search regardless of who sent the invitation.
|
|
278
|
+
# @option opts [AccountSearchArea] :area The part of the portal to search in: `All`, the default, searches members and guests together, `People` leaves the guests out, and `Guests` returns guests only - and for a caller who is not a DocSpace administrator, only the guests that caller is related to.
|
|
279
|
+
# @option opts [Array<EmployeeType>] :employee_types Keeps only the users of the listed types, combined as alternatives. An empty list, which is the default, searches every type.
|
|
280
|
+
# @option opts [Integer] :count The size of the page, counting groups and users together. It defaults to 100, which is also the largest value the operation accepts.
|
|
281
|
+
# @option opts [Integer] :start_index The number of matches to skip before the page starts, counted over the groups and users together. It defaults to 0, and the total number of matches is reported in the total count of the response.
|
|
282
|
+
# @option opts [String] :filter_separator The character that splits `filterValue` into several terms, of which any one may match. Omit it to split the value on spaces instead, in which case every term has to match.
|
|
283
|
+
# @option opts [String] :filter_value The text to search for, matched case-insensitively against the first name, the last name and the email. It is required in practice: while it is empty the search returns nothing at all rather than every account.
|
|
284
|
+
# @return [Array<(AccountEntryArrayWrapper, Integer, Hash)>] AccountEntryArrayWrapper data, response status code and response headers
|
|
285
|
+
def get_accounts_entries_with_rooms_shared_with_http_info(id, opts = {})
|
|
286
|
+
if @api_client.config.debugging
|
|
287
|
+
@api_client.config.logger.debug 'Calling API: People::SearchApi.get_accounts_entries_with_rooms_shared ...'
|
|
288
|
+
end
|
|
289
|
+
# verify the required parameter 'id' is set
|
|
290
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
291
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling People::SearchApi.get_accounts_entries_with_rooms_shared"
|
|
292
|
+
end
|
|
293
|
+
if @api_client.config.client_side_validation && !opts[:'count'].nil? && opts[:'count'] > 100
|
|
294
|
+
fail ArgumentError, 'invalid value for "opts[:"count"]" when calling People::SearchApi.get_accounts_entries_with_rooms_shared, must be smaller than or equal to 100.'
|
|
295
|
+
end
|
|
296
|
+
|
|
297
|
+
if @api_client.config.client_side_validation && !opts[:'count'].nil? && opts[:'count'] < 1
|
|
298
|
+
fail ArgumentError, 'invalid value for "opts[:"count"]" when calling People::SearchApi.get_accounts_entries_with_rooms_shared, must be greater than or equal to 1.'
|
|
299
|
+
end
|
|
300
|
+
|
|
301
|
+
# resource path
|
|
302
|
+
local_var_path = '/api/2.0/accounts/room/{id}/search'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
303
|
+
|
|
304
|
+
# query parameters
|
|
305
|
+
query_params = opts[:query_params] || {}
|
|
306
|
+
query_params[:'employeeStatus'] = opts[:'employee_status'] if !opts[:'employee_status'].nil?
|
|
307
|
+
query_params[:'activationStatus'] = opts[:'activation_status'] if !opts[:'activation_status'].nil?
|
|
308
|
+
query_params[:'excludeShared'] = opts[:'exclude_shared'] if !opts[:'exclude_shared'].nil?
|
|
309
|
+
query_params[:'includeShared'] = opts[:'include_shared'] if !opts[:'include_shared'].nil?
|
|
310
|
+
query_params[:'invitedByMe'] = opts[:'invited_by_me'] if !opts[:'invited_by_me'].nil?
|
|
311
|
+
query_params[:'inviterId'] = opts[:'inviter_id'] if !opts[:'inviter_id'].nil?
|
|
312
|
+
query_params[:'area'] = opts[:'area'] if !opts[:'area'].nil?
|
|
313
|
+
query_params[:'employeeTypes'] = @api_client.build_collection_param(opts[:'employee_types'], :multi) if !opts[:'employee_types'].nil?
|
|
314
|
+
query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
|
|
315
|
+
query_params[:'startIndex'] = opts[:'start_index'] if !opts[:'start_index'].nil?
|
|
316
|
+
query_params[:'filterSeparator'] = opts[:'filter_separator'] if !opts[:'filter_separator'].nil?
|
|
317
|
+
query_params[:'filterValue'] = opts[:'filter_value'] if !opts[:'filter_value'].nil?
|
|
318
|
+
|
|
319
|
+
# header parameters
|
|
320
|
+
header_params = opts[:header_params] || {}
|
|
321
|
+
# HTTP header 'Accept' (if needed)
|
|
322
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
323
|
+
|
|
324
|
+
# form parameters
|
|
325
|
+
form_params = opts[:form_params] || {}
|
|
326
|
+
|
|
327
|
+
# http body (model)
|
|
328
|
+
post_body = opts[:debug_body]
|
|
329
|
+
|
|
330
|
+
# return_type
|
|
331
|
+
return_type = opts[:debug_return_type] || 'AccountEntryArrayWrapper'
|
|
332
|
+
|
|
333
|
+
# auth_names
|
|
334
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
335
|
+
|
|
336
|
+
new_options = opts.merge(
|
|
337
|
+
:operation => :"People::SearchApi.get_accounts_entries_with_rooms_shared",
|
|
338
|
+
:header_params => header_params,
|
|
339
|
+
:query_params => query_params,
|
|
340
|
+
:form_params => form_params,
|
|
341
|
+
:body => post_body,
|
|
342
|
+
:auth_names => auth_names,
|
|
343
|
+
:return_type => return_type
|
|
344
|
+
)
|
|
345
|
+
|
|
346
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
347
|
+
if @api_client.config.debugging
|
|
348
|
+
@api_client.config.logger.debug "API called: People::SearchApi#get_accounts_entries_with_rooms_shared\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
349
|
+
end
|
|
350
|
+
return data, status_code, headers
|
|
351
|
+
end
|
|
352
|
+
|
|
353
|
+
# Search users
|
|
354
|
+
# Searches the active accounts of the portal by a term taken from the path, and is the same search as `GET api/2.0/people/search`, which takes the term in the query string instead. Only a DocSpace administrator may call it; every other account, including a room admin, gets 403. Only accounts with the `Active` status are searched, so a pending invitation and a disabled account are never found - use `GET api/2.0/people/filter` to search across states. The call is read-only and is not paged: every match is streamed, without a total. `filterBy` set to `group` turns `text` into a group ID and keeps only the members of that group, so `text` then has to be a valid identifier. The answer holds full profiles.
|
|
355
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-search/
|
|
356
|
+
# @param query [String] The term to look for, taken from the route. Only accounts with the `Active` status are searched.
|
|
357
|
+
# @param [Hash] opts the optional parameters
|
|
358
|
+
# @option opts [String] :filter_by The only recognised value is `group`, which turns `filterValue` into a group ID and keeps only the members of that group. Any other value, and omitting the field, applies no group filter.
|
|
359
|
+
# @option opts [String] :filter_value The group ID to keep the members of, used only when `filterBy` is `group`. It has to be a valid identifier - a group name is not accepted.
|
|
360
|
+
# @return [EmployeeFullArrayWrapper]
|
|
361
|
+
def get_search(query, opts = {})
|
|
362
|
+
data, _status_code, _headers = get_search_with_http_info(query, opts)
|
|
363
|
+
data
|
|
364
|
+
end
|
|
365
|
+
|
|
366
|
+
# Search users
|
|
367
|
+
# Searches the active accounts of the portal by a term taken from the path, and is the same search as `GET api/2.0/people/search`, which takes the term in the query string instead. Only a DocSpace administrator may call it; every other account, including a room admin, gets 403. Only accounts with the `Active` status are searched, so a pending invitation and a disabled account are never found - use `GET api/2.0/people/filter` to search across states. The call is read-only and is not paged: every match is streamed, without a total. `filterBy` set to `group` turns `text` into a group ID and keeps only the members of that group, so `text` then has to be a valid identifier. The answer holds full profiles.
|
|
368
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-search/
|
|
369
|
+
# @param query [String] The term to look for, taken from the route. Only accounts with the `Active` status are searched.
|
|
370
|
+
# @param [Hash] opts the optional parameters
|
|
371
|
+
# @option opts [String] :filter_by The only recognised value is `group`, which turns `filterValue` into a group ID and keeps only the members of that group. Any other value, and omitting the field, applies no group filter.
|
|
372
|
+
# @option opts [String] :filter_value The group ID to keep the members of, used only when `filterBy` is `group`. It has to be a valid identifier - a group name is not accepted.
|
|
373
|
+
# @return [Array<(EmployeeFullArrayWrapper, Integer, Hash)>] EmployeeFullArrayWrapper data, response status code and response headers
|
|
374
|
+
def get_search_with_http_info(query, opts = {})
|
|
375
|
+
if @api_client.config.debugging
|
|
376
|
+
@api_client.config.logger.debug 'Calling API: People::SearchApi.get_search ...'
|
|
377
|
+
end
|
|
378
|
+
# verify the required parameter 'query' is set
|
|
379
|
+
if @api_client.config.client_side_validation && query.nil?
|
|
380
|
+
fail ArgumentError, "Missing the required parameter 'query' when calling People::SearchApi.get_search"
|
|
381
|
+
end
|
|
382
|
+
# resource path
|
|
383
|
+
local_var_path = '/api/2.0/people/@search/{query}'.sub('{' + 'query' + '}', CGI.escape(query.to_s))
|
|
384
|
+
|
|
385
|
+
# query parameters
|
|
386
|
+
query_params = opts[:query_params] || {}
|
|
387
|
+
query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?
|
|
388
|
+
query_params[:'filterValue'] = opts[:'filter_value'] if !opts[:'filter_value'].nil?
|
|
389
|
+
|
|
390
|
+
# header parameters
|
|
391
|
+
header_params = opts[:header_params] || {}
|
|
392
|
+
# HTTP header 'Accept' (if needed)
|
|
393
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
394
|
+
|
|
395
|
+
# form parameters
|
|
396
|
+
form_params = opts[:form_params] || {}
|
|
397
|
+
|
|
398
|
+
# http body (model)
|
|
399
|
+
post_body = opts[:debug_body]
|
|
400
|
+
|
|
401
|
+
# return_type
|
|
402
|
+
return_type = opts[:debug_return_type] || 'EmployeeFullArrayWrapper'
|
|
403
|
+
|
|
404
|
+
# auth_names
|
|
405
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
406
|
+
|
|
407
|
+
new_options = opts.merge(
|
|
408
|
+
:operation => :"People::SearchApi.get_search",
|
|
409
|
+
:header_params => header_params,
|
|
410
|
+
:query_params => query_params,
|
|
411
|
+
:form_params => form_params,
|
|
412
|
+
:body => post_body,
|
|
413
|
+
:auth_names => auth_names,
|
|
414
|
+
:return_type => return_type
|
|
415
|
+
)
|
|
416
|
+
|
|
417
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
418
|
+
if @api_client.config.debugging
|
|
419
|
+
@api_client.config.logger.debug "API called: People::SearchApi#get_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
420
|
+
end
|
|
421
|
+
return data, status_code, headers
|
|
422
|
+
end
|
|
423
|
+
|
|
424
|
+
# Filter users in brief
|
|
425
|
+
# Returns a page of portal accounts selected by the full set of account filters, with the short profile of each of them - the identifying fields, the avatar and the display name, without the contacts, the groups or the quota. The caller has to be a room admin, a DocSpace admin or a People module admin; a member or a guest gets 403. The call is read-only, paged by `count` and `startIndex`, ordered by `sortBy` and `sortOrder`, and reports the number of matches in the total count of the response. It accepts exactly the same filters as `GET api/2.0/people/filter` and differs only in how much of each profile comes back, so prefer this one for pickers, mentions and any list that shows names, and switch to the other only when the full profile is needed. Filters combine as conditions that all have to hold, and the same interactions apply: `withoutGroup` makes `groupId` irrelevant, `employeeType` wins over `employeeTypes`, and `area` cancels the type filters that contradict it.
|
|
426
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-simple-by-filter/
|
|
427
|
+
# @param [Hash] opts the optional parameters
|
|
428
|
+
# @option opts [EmployeeStatus] :employee_status Keeps only the accounts in the given state: `Active` for working accounts, `Terminated` for disabled ones and `Pending` for open invitations. Omit it to search every state.
|
|
429
|
+
# @option opts [String] :group_id Keeps only the members of this group, or excludes them when `excludeGroup` is true. It is ignored when `withoutGroup` is set.
|
|
430
|
+
# @option opts [EmployeeActivationStatus] :activation_status Keeps only the accounts whose activation is in the given state: `NotActivated`, `Activated`, `Pending` or `AutoGenerated`. Omit it to search every state.
|
|
431
|
+
# @option opts [EmployeeType] :employee_type Keeps only the accounts of this single type: `DocSpaceAdmin`, `RoomAdmin`, `User` or `Guest`. When it is sent it wins over `employeeTypes`, and a type that contradicts `area` is dropped.
|
|
432
|
+
# @option opts [Array<Integer>] :employee_types Keeps the accounts of any of the listed types, combined as alternatives. It is ignored when `employeeType` is also sent.
|
|
433
|
+
# @option opts [Boolean] :is_administrator Set it to true to keep only the DocSpace administrators and the module administrators. Setting it to false is the same as omitting it and does not exclude administrators.
|
|
434
|
+
# @option opts [Payments] :payments Keeps only the accounts that take a paid seat when `Paid`, or only the guests and members that do not when `Free`. Omit it to search both.
|
|
435
|
+
# @option opts [AccountLoginType] :account_login_type Keeps only the accounts that sign in this way: `SSO`, `LDAP`, or `Standart` for an ordinary portal password. Omit it to search all of them.
|
|
436
|
+
# @option opts [QuotaFilter] :quota_filter Keeps only the accounts whose storage quota is the portal default when `Default`, or set individually when `Custom`. `All`, which is the same as omitting the field, searches both.
|
|
437
|
+
# @option opts [Boolean] :without_group Set it to true to keep only the accounts that belong to no group at all, which makes `groupId` and `excludeGroup` irrelevant.
|
|
438
|
+
# @option opts [Boolean] :exclude_group Inverts `groupId`: with true the members of that group are left out instead of being the only ones kept. It has no effect without `groupId`.
|
|
439
|
+
# @option opts [Boolean] :invited_by_me Keeps only the accounts invited by the caller when true, and only those invited by somebody else when false. Omit it to search regardless of who sent the invitation.
|
|
440
|
+
# @option opts [String] :inviter_id Keeps only the accounts invited by the account with this ID. Omit it to search regardless of who sent the invitation.
|
|
441
|
+
# @option opts [AccountSearchArea] :area The part of the portal to search in: `All`, the default, searches members and guests together, `People` leaves the guests out, and `Guests` returns guests only. It also cancels the type filters that contradict it.
|
|
442
|
+
# @option opts [Integer] :count The size of the page. It defaults to 100, which is also the largest value the operation accepts.
|
|
443
|
+
# @option opts [Integer] :start_index The number of matches to skip before the page starts. It defaults to 0, and the total number of matches is reported in the total count of the response.
|
|
444
|
+
# @option opts [String] :sort_by What to order the accounts by, compared without regard to case: `FirstName`, `LastName`, `DisplayName`, `Type`, `Email`, `Department`, `UsedSpace`, `CreatedBy` or `RegistrationDate`.
|
|
445
|
+
# @option opts [SortOrder] :sort_order The direction of the ordering: `Ascending`, which is the default, or `Descending`.
|
|
446
|
+
# @option opts [String] :filter_separator The character that splits `filterValue` into several terms, of which any one may match. Omit it to split the value on spaces instead, in which case every term has to match.
|
|
447
|
+
# @option opts [String] :filter_value The text to match against the first name, the last name and the email, case-insensitively. Omit it to apply no text filter at all.
|
|
448
|
+
# @return [EmployeeArrayWrapper]
|
|
449
|
+
def get_simple_by_filter(opts = {})
|
|
450
|
+
data, _status_code, _headers = get_simple_by_filter_with_http_info(opts)
|
|
451
|
+
data
|
|
452
|
+
end
|
|
453
|
+
|
|
454
|
+
# Filter users in brief
|
|
455
|
+
# Returns a page of portal accounts selected by the full set of account filters, with the short profile of each of them - the identifying fields, the avatar and the display name, without the contacts, the groups or the quota. The caller has to be a room admin, a DocSpace admin or a People module admin; a member or a guest gets 403. The call is read-only, paged by `count` and `startIndex`, ordered by `sortBy` and `sortOrder`, and reports the number of matches in the total count of the response. It accepts exactly the same filters as `GET api/2.0/people/filter` and differs only in how much of each profile comes back, so prefer this one for pickers, mentions and any list that shows names, and switch to the other only when the full profile is needed. Filters combine as conditions that all have to hold, and the same interactions apply: `withoutGroup` makes `groupId` irrelevant, `employeeType` wins over `employeeTypes`, and `area` cancels the type filters that contradict it.
|
|
456
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-simple-by-filter/
|
|
457
|
+
# @param [Hash] opts the optional parameters
|
|
458
|
+
# @option opts [EmployeeStatus] :employee_status Keeps only the accounts in the given state: `Active` for working accounts, `Terminated` for disabled ones and `Pending` for open invitations. Omit it to search every state.
|
|
459
|
+
# @option opts [String] :group_id Keeps only the members of this group, or excludes them when `excludeGroup` is true. It is ignored when `withoutGroup` is set.
|
|
460
|
+
# @option opts [EmployeeActivationStatus] :activation_status Keeps only the accounts whose activation is in the given state: `NotActivated`, `Activated`, `Pending` or `AutoGenerated`. Omit it to search every state.
|
|
461
|
+
# @option opts [EmployeeType] :employee_type Keeps only the accounts of this single type: `DocSpaceAdmin`, `RoomAdmin`, `User` or `Guest`. When it is sent it wins over `employeeTypes`, and a type that contradicts `area` is dropped.
|
|
462
|
+
# @option opts [Array<Integer>] :employee_types Keeps the accounts of any of the listed types, combined as alternatives. It is ignored when `employeeType` is also sent.
|
|
463
|
+
# @option opts [Boolean] :is_administrator Set it to true to keep only the DocSpace administrators and the module administrators. Setting it to false is the same as omitting it and does not exclude administrators.
|
|
464
|
+
# @option opts [Payments] :payments Keeps only the accounts that take a paid seat when `Paid`, or only the guests and members that do not when `Free`. Omit it to search both.
|
|
465
|
+
# @option opts [AccountLoginType] :account_login_type Keeps only the accounts that sign in this way: `SSO`, `LDAP`, or `Standart` for an ordinary portal password. Omit it to search all of them.
|
|
466
|
+
# @option opts [QuotaFilter] :quota_filter Keeps only the accounts whose storage quota is the portal default when `Default`, or set individually when `Custom`. `All`, which is the same as omitting the field, searches both.
|
|
467
|
+
# @option opts [Boolean] :without_group Set it to true to keep only the accounts that belong to no group at all, which makes `groupId` and `excludeGroup` irrelevant.
|
|
468
|
+
# @option opts [Boolean] :exclude_group Inverts `groupId`: with true the members of that group are left out instead of being the only ones kept. It has no effect without `groupId`.
|
|
469
|
+
# @option opts [Boolean] :invited_by_me Keeps only the accounts invited by the caller when true, and only those invited by somebody else when false. Omit it to search regardless of who sent the invitation.
|
|
470
|
+
# @option opts [String] :inviter_id Keeps only the accounts invited by the account with this ID. Omit it to search regardless of who sent the invitation.
|
|
471
|
+
# @option opts [AccountSearchArea] :area The part of the portal to search in: `All`, the default, searches members and guests together, `People` leaves the guests out, and `Guests` returns guests only. It also cancels the type filters that contradict it.
|
|
472
|
+
# @option opts [Integer] :count The size of the page. It defaults to 100, which is also the largest value the operation accepts.
|
|
473
|
+
# @option opts [Integer] :start_index The number of matches to skip before the page starts. It defaults to 0, and the total number of matches is reported in the total count of the response.
|
|
474
|
+
# @option opts [String] :sort_by What to order the accounts by, compared without regard to case: `FirstName`, `LastName`, `DisplayName`, `Type`, `Email`, `Department`, `UsedSpace`, `CreatedBy` or `RegistrationDate`.
|
|
475
|
+
# @option opts [SortOrder] :sort_order The direction of the ordering: `Ascending`, which is the default, or `Descending`.
|
|
476
|
+
# @option opts [String] :filter_separator The character that splits `filterValue` into several terms, of which any one may match. Omit it to split the value on spaces instead, in which case every term has to match.
|
|
477
|
+
# @option opts [String] :filter_value The text to match against the first name, the last name and the email, case-insensitively. Omit it to apply no text filter at all.
|
|
478
|
+
# @return [Array<(EmployeeArrayWrapper, Integer, Hash)>] EmployeeArrayWrapper data, response status code and response headers
|
|
479
|
+
def get_simple_by_filter_with_http_info(opts = {})
|
|
480
|
+
if @api_client.config.debugging
|
|
481
|
+
@api_client.config.logger.debug 'Calling API: People::SearchApi.get_simple_by_filter ...'
|
|
482
|
+
end
|
|
483
|
+
allowable_values = [0, 1, 2, 3, 4]
|
|
484
|
+
if @api_client.config.client_side_validation && opts[:'employee_types'] && !opts[:'employee_types'].all? { |item| allowable_values.include?(item) }
|
|
485
|
+
fail ArgumentError, "invalid value for \"employee_types\", must include one of #{allowable_values}"
|
|
486
|
+
end
|
|
487
|
+
if @api_client.config.client_side_validation && !opts[:'count'].nil? && opts[:'count'] > 100
|
|
488
|
+
fail ArgumentError, 'invalid value for "opts[:"count"]" when calling People::SearchApi.get_simple_by_filter, must be smaller than or equal to 100.'
|
|
489
|
+
end
|
|
490
|
+
|
|
491
|
+
if @api_client.config.client_side_validation && !opts[:'count'].nil? && opts[:'count'] < 1
|
|
492
|
+
fail ArgumentError, 'invalid value for "opts[:"count"]" when calling People::SearchApi.get_simple_by_filter, must be greater than or equal to 1.'
|
|
493
|
+
end
|
|
494
|
+
|
|
495
|
+
# resource path
|
|
496
|
+
local_var_path = '/api/2.0/people/simple/filter'
|
|
497
|
+
|
|
498
|
+
# query parameters
|
|
499
|
+
query_params = opts[:query_params] || {}
|
|
500
|
+
query_params[:'employeeStatus'] = opts[:'employee_status'] if !opts[:'employee_status'].nil?
|
|
501
|
+
query_params[:'groupId'] = opts[:'group_id'] if !opts[:'group_id'].nil?
|
|
502
|
+
query_params[:'activationStatus'] = opts[:'activation_status'] if !opts[:'activation_status'].nil?
|
|
503
|
+
query_params[:'employeeType'] = opts[:'employee_type'] if !opts[:'employee_type'].nil?
|
|
504
|
+
query_params[:'employeeTypes'] = @api_client.build_collection_param(opts[:'employee_types'], :multi) if !opts[:'employee_types'].nil?
|
|
505
|
+
query_params[:'isAdministrator'] = opts[:'is_administrator'] if !opts[:'is_administrator'].nil?
|
|
506
|
+
query_params[:'payments'] = opts[:'payments'] if !opts[:'payments'].nil?
|
|
507
|
+
query_params[:'accountLoginType'] = opts[:'account_login_type'] if !opts[:'account_login_type'].nil?
|
|
508
|
+
query_params[:'quotaFilter'] = opts[:'quota_filter'] if !opts[:'quota_filter'].nil?
|
|
509
|
+
query_params[:'withoutGroup'] = opts[:'without_group'] if !opts[:'without_group'].nil?
|
|
510
|
+
query_params[:'excludeGroup'] = opts[:'exclude_group'] if !opts[:'exclude_group'].nil?
|
|
511
|
+
query_params[:'invitedByMe'] = opts[:'invited_by_me'] if !opts[:'invited_by_me'].nil?
|
|
512
|
+
query_params[:'inviterId'] = opts[:'inviter_id'] if !opts[:'inviter_id'].nil?
|
|
513
|
+
query_params[:'area'] = opts[:'area'] if !opts[:'area'].nil?
|
|
514
|
+
query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
|
|
515
|
+
query_params[:'startIndex'] = opts[:'start_index'] if !opts[:'start_index'].nil?
|
|
516
|
+
query_params[:'sortBy'] = opts[:'sort_by'] if !opts[:'sort_by'].nil?
|
|
517
|
+
query_params[:'sortOrder'] = opts[:'sort_order'] if !opts[:'sort_order'].nil?
|
|
518
|
+
query_params[:'filterSeparator'] = opts[:'filter_separator'] if !opts[:'filter_separator'].nil?
|
|
519
|
+
query_params[:'filterValue'] = opts[:'filter_value'] if !opts[:'filter_value'].nil?
|
|
520
|
+
|
|
521
|
+
# header parameters
|
|
522
|
+
header_params = opts[:header_params] || {}
|
|
523
|
+
# HTTP header 'Accept' (if needed)
|
|
524
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
525
|
+
|
|
526
|
+
# form parameters
|
|
527
|
+
form_params = opts[:form_params] || {}
|
|
528
|
+
|
|
529
|
+
# http body (model)
|
|
530
|
+
post_body = opts[:debug_body]
|
|
531
|
+
|
|
532
|
+
# return_type
|
|
533
|
+
return_type = opts[:debug_return_type] || 'EmployeeArrayWrapper'
|
|
534
|
+
|
|
535
|
+
# auth_names
|
|
536
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
537
|
+
|
|
538
|
+
new_options = opts.merge(
|
|
539
|
+
:operation => :"People::SearchApi.get_simple_by_filter",
|
|
540
|
+
:header_params => header_params,
|
|
541
|
+
:query_params => query_params,
|
|
542
|
+
:form_params => form_params,
|
|
543
|
+
:body => post_body,
|
|
544
|
+
:auth_names => auth_names,
|
|
545
|
+
:return_type => return_type
|
|
546
|
+
)
|
|
547
|
+
|
|
548
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
549
|
+
if @api_client.config.debugging
|
|
550
|
+
@api_client.config.logger.debug "API called: People::SearchApi#get_simple_by_filter\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
551
|
+
end
|
|
552
|
+
return data, status_code, headers
|
|
553
|
+
end
|
|
554
|
+
|
|
555
|
+
# Search users for a file
|
|
556
|
+
# Returns the accounts that are relevant to the file with the ID given in the route, and reports for each of them whether it already has access to that file. The caller only needs read access to the file, not the right to manage its access, but a guest may not call it at all; an ID that matches no file answers 404. The call is read-only, works without a filter - leaving `filterValue` empty returns every matching account rather than nothing - and is paged by `count` and `startIndex`, with the number of matches in the total count of the response. Pass `excludeShared` to keep only the accounts that have no access yet, `includeShared` to keep only those that already have it, and neither to get both kinds with the `shared` field telling them apart. A DocSpace administrator additionally sees the guests that are not related to the caller. To search users and groups together, or to build an access dialog that needs the right to manage sharing, use `GET api/2.0/accounts/file/{id}/search` instead.
|
|
557
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-users-with-files-shared/
|
|
558
|
+
# @param id [Integer, String] The ID of the room, folder or file the search is run against, taken from the route. It is an integer for an entry stored in DocSpace and a provider-specific string for an entry in a connected third-party storage.
|
|
559
|
+
# @param [Hash] opts the optional parameters
|
|
560
|
+
# @option opts [EmployeeStatus] :employee_status Keeps only the accounts in the given state: `Active` for working accounts, `Terminated` for disabled ones and `Pending` for open invitations. Omit it to search every state.
|
|
561
|
+
# @option opts [EmployeeActivationStatus] :activation_status Keeps only the accounts whose activation is in the given state: `NotActivated`, `Activated`, `Pending` or `AutoGenerated`. Omit it to search every state.
|
|
562
|
+
# @option opts [Boolean] :exclude_shared Keeps only the accounts that do not have access to the entry yet, which is the set to offer when granting access. It takes precedence over `includeShared`, and every returned entry has `shared` set to false.
|
|
563
|
+
# @option opts [Boolean] :include_shared Keeps only the accounts that already have access to the entry, which is the set to offer when changing or revoking access. Every returned entry has `shared` set to true, and the flag is ignored when `excludeShared` is also set.
|
|
564
|
+
# @option opts [Boolean] :invited_by_me Keeps only the accounts invited by the caller when true, and only those invited by somebody else when false. Omit it to search regardless of who sent the invitation.
|
|
565
|
+
# @option opts [String] :inviter_id Keeps only the accounts invited by the account with this ID. Omit it to search regardless of who sent the invitation.
|
|
566
|
+
# @option opts [AccountSearchArea] :area The part of the portal to search in: `All`, the default, searches members and guests together, `People` leaves the guests out, and `Guests` returns guests only - and for a caller who is not a DocSpace administrator, only the guests that caller is related to.
|
|
567
|
+
# @option opts [Array<EmployeeType>] :employee_types Keeps only the accounts of the listed types, combined as alternatives. An empty list, which is the default, searches every type.
|
|
568
|
+
# @option opts [Integer] :count The size of the page. It defaults to 100, which is also the largest value the operation accepts.
|
|
569
|
+
# @option opts [Integer] :start_index The number of matches to skip before the page starts. It defaults to 0, and the total number of matches is reported in the total count of the response.
|
|
570
|
+
# @option opts [String] :filter_separator The character that splits `filterValue` into several terms, of which any one may match. Omit it to split the value on spaces instead, in which case every term has to match.
|
|
571
|
+
# @option opts [String] :filter_value The text to match against the first name, the last name and the email, case-insensitively. Omit it to get every account the caller may offer access to.
|
|
572
|
+
# @return [EmployeeFullArrayWrapper]
|
|
573
|
+
def get_users_with_files_shared(id, opts = {})
|
|
574
|
+
data, _status_code, _headers = get_users_with_files_shared_with_http_info(id, opts)
|
|
575
|
+
data
|
|
576
|
+
end
|
|
577
|
+
|
|
578
|
+
# Search users for a file
|
|
579
|
+
# Returns the accounts that are relevant to the file with the ID given in the route, and reports for each of them whether it already has access to that file. The caller only needs read access to the file, not the right to manage its access, but a guest may not call it at all; an ID that matches no file answers 404. The call is read-only, works without a filter - leaving `filterValue` empty returns every matching account rather than nothing - and is paged by `count` and `startIndex`, with the number of matches in the total count of the response. Pass `excludeShared` to keep only the accounts that have no access yet, `includeShared` to keep only those that already have it, and neither to get both kinds with the `shared` field telling them apart. A DocSpace administrator additionally sees the guests that are not related to the caller. To search users and groups together, or to build an access dialog that needs the right to manage sharing, use `GET api/2.0/accounts/file/{id}/search` instead.
|
|
580
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-users-with-files-shared/
|
|
581
|
+
# @param id [Integer, String] The ID of the room, folder or file the search is run against, taken from the route. It is an integer for an entry stored in DocSpace and a provider-specific string for an entry in a connected third-party storage.
|
|
582
|
+
# @param [Hash] opts the optional parameters
|
|
583
|
+
# @option opts [EmployeeStatus] :employee_status Keeps only the accounts in the given state: `Active` for working accounts, `Terminated` for disabled ones and `Pending` for open invitations. Omit it to search every state.
|
|
584
|
+
# @option opts [EmployeeActivationStatus] :activation_status Keeps only the accounts whose activation is in the given state: `NotActivated`, `Activated`, `Pending` or `AutoGenerated`. Omit it to search every state.
|
|
585
|
+
# @option opts [Boolean] :exclude_shared Keeps only the accounts that do not have access to the entry yet, which is the set to offer when granting access. It takes precedence over `includeShared`, and every returned entry has `shared` set to false.
|
|
586
|
+
# @option opts [Boolean] :include_shared Keeps only the accounts that already have access to the entry, which is the set to offer when changing or revoking access. Every returned entry has `shared` set to true, and the flag is ignored when `excludeShared` is also set.
|
|
587
|
+
# @option opts [Boolean] :invited_by_me Keeps only the accounts invited by the caller when true, and only those invited by somebody else when false. Omit it to search regardless of who sent the invitation.
|
|
588
|
+
# @option opts [String] :inviter_id Keeps only the accounts invited by the account with this ID. Omit it to search regardless of who sent the invitation.
|
|
589
|
+
# @option opts [AccountSearchArea] :area The part of the portal to search in: `All`, the default, searches members and guests together, `People` leaves the guests out, and `Guests` returns guests only - and for a caller who is not a DocSpace administrator, only the guests that caller is related to.
|
|
590
|
+
# @option opts [Array<EmployeeType>] :employee_types Keeps only the accounts of the listed types, combined as alternatives. An empty list, which is the default, searches every type.
|
|
591
|
+
# @option opts [Integer] :count The size of the page. It defaults to 100, which is also the largest value the operation accepts.
|
|
592
|
+
# @option opts [Integer] :start_index The number of matches to skip before the page starts. It defaults to 0, and the total number of matches is reported in the total count of the response.
|
|
593
|
+
# @option opts [String] :filter_separator The character that splits `filterValue` into several terms, of which any one may match. Omit it to split the value on spaces instead, in which case every term has to match.
|
|
594
|
+
# @option opts [String] :filter_value The text to match against the first name, the last name and the email, case-insensitively. Omit it to get every account the caller may offer access to.
|
|
595
|
+
# @return [Array<(EmployeeFullArrayWrapper, Integer, Hash)>] EmployeeFullArrayWrapper data, response status code and response headers
|
|
596
|
+
def get_users_with_files_shared_with_http_info(id, opts = {})
|
|
597
|
+
if @api_client.config.debugging
|
|
598
|
+
@api_client.config.logger.debug 'Calling API: People::SearchApi.get_users_with_files_shared ...'
|
|
599
|
+
end
|
|
600
|
+
# verify the required parameter 'id' is set
|
|
601
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
602
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling People::SearchApi.get_users_with_files_shared"
|
|
603
|
+
end
|
|
604
|
+
if @api_client.config.client_side_validation && !opts[:'count'].nil? && opts[:'count'] > 100
|
|
605
|
+
fail ArgumentError, 'invalid value for "opts[:"count"]" when calling People::SearchApi.get_users_with_files_shared, must be smaller than or equal to 100.'
|
|
606
|
+
end
|
|
607
|
+
|
|
608
|
+
if @api_client.config.client_side_validation && !opts[:'count'].nil? && opts[:'count'] < 1
|
|
609
|
+
fail ArgumentError, 'invalid value for "opts[:"count"]" when calling People::SearchApi.get_users_with_files_shared, must be greater than or equal to 1.'
|
|
610
|
+
end
|
|
611
|
+
|
|
612
|
+
# resource path
|
|
613
|
+
local_var_path = '/api/2.0/people/file/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
614
|
+
|
|
615
|
+
# query parameters
|
|
616
|
+
query_params = opts[:query_params] || {}
|
|
617
|
+
query_params[:'employeeStatus'] = opts[:'employee_status'] if !opts[:'employee_status'].nil?
|
|
618
|
+
query_params[:'activationStatus'] = opts[:'activation_status'] if !opts[:'activation_status'].nil?
|
|
619
|
+
query_params[:'excludeShared'] = opts[:'exclude_shared'] if !opts[:'exclude_shared'].nil?
|
|
620
|
+
query_params[:'includeShared'] = opts[:'include_shared'] if !opts[:'include_shared'].nil?
|
|
621
|
+
query_params[:'invitedByMe'] = opts[:'invited_by_me'] if !opts[:'invited_by_me'].nil?
|
|
622
|
+
query_params[:'inviterId'] = opts[:'inviter_id'] if !opts[:'inviter_id'].nil?
|
|
623
|
+
query_params[:'area'] = opts[:'area'] if !opts[:'area'].nil?
|
|
624
|
+
query_params[:'employeeTypes'] = @api_client.build_collection_param(opts[:'employee_types'], :multi) if !opts[:'employee_types'].nil?
|
|
625
|
+
query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
|
|
626
|
+
query_params[:'startIndex'] = opts[:'start_index'] if !opts[:'start_index'].nil?
|
|
627
|
+
query_params[:'filterSeparator'] = opts[:'filter_separator'] if !opts[:'filter_separator'].nil?
|
|
628
|
+
query_params[:'filterValue'] = opts[:'filter_value'] if !opts[:'filter_value'].nil?
|
|
629
|
+
|
|
630
|
+
# header parameters
|
|
631
|
+
header_params = opts[:header_params] || {}
|
|
632
|
+
# HTTP header 'Accept' (if needed)
|
|
633
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
634
|
+
|
|
635
|
+
# form parameters
|
|
636
|
+
form_params = opts[:form_params] || {}
|
|
637
|
+
|
|
638
|
+
# http body (model)
|
|
639
|
+
post_body = opts[:debug_body]
|
|
640
|
+
|
|
641
|
+
# return_type
|
|
642
|
+
return_type = opts[:debug_return_type] || 'EmployeeFullArrayWrapper'
|
|
643
|
+
|
|
644
|
+
# auth_names
|
|
645
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
646
|
+
|
|
647
|
+
new_options = opts.merge(
|
|
648
|
+
:operation => :"People::SearchApi.get_users_with_files_shared",
|
|
649
|
+
:header_params => header_params,
|
|
650
|
+
:query_params => query_params,
|
|
651
|
+
:form_params => form_params,
|
|
652
|
+
:body => post_body,
|
|
653
|
+
:auth_names => auth_names,
|
|
654
|
+
:return_type => return_type
|
|
655
|
+
)
|
|
656
|
+
|
|
657
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
658
|
+
if @api_client.config.debugging
|
|
659
|
+
@api_client.config.logger.debug "API called: People::SearchApi#get_users_with_files_shared\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
660
|
+
end
|
|
661
|
+
return data, status_code, headers
|
|
662
|
+
end
|
|
663
|
+
|
|
664
|
+
# Search users for a folder
|
|
665
|
+
# Returns the accounts that are relevant to the folder with the ID given in the route, and reports for each of them whether it already has access to that folder. The caller only needs read access to the folder, not the right to manage its access, but a guest may not call it at all; an ID that matches no folder answers 404. The call is read-only, works without a filter - leaving `filterValue` empty returns every matching account rather than nothing - and is paged by `count` and `startIndex`, with the number of matches in the total count of the response. Pass `excludeShared` to keep only the accounts that have no access yet, `includeShared` to keep only those that already have it, and neither to get both kinds with the `shared` field telling them apart. A DocSpace administrator additionally sees the guests that are not related to the caller. To search users and groups together, or to build an access dialog that needs the right to manage sharing, use `GET api/2.0/accounts/folder/{id}/search` instead.
|
|
666
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-users-with-folders-shared/
|
|
667
|
+
# @param id [Integer, String] The ID of the room, folder or file the search is run against, taken from the route. It is an integer for an entry stored in DocSpace and a provider-specific string for an entry in a connected third-party storage.
|
|
668
|
+
# @param [Hash] opts the optional parameters
|
|
669
|
+
# @option opts [EmployeeStatus] :employee_status Keeps only the accounts in the given state: `Active` for working accounts, `Terminated` for disabled ones and `Pending` for open invitations. Omit it to search every state.
|
|
670
|
+
# @option opts [EmployeeActivationStatus] :activation_status Keeps only the accounts whose activation is in the given state: `NotActivated`, `Activated`, `Pending` or `AutoGenerated`. Omit it to search every state.
|
|
671
|
+
# @option opts [Boolean] :exclude_shared Keeps only the accounts that do not have access to the entry yet, which is the set to offer when granting access. It takes precedence over `includeShared`, and every returned entry has `shared` set to false.
|
|
672
|
+
# @option opts [Boolean] :include_shared Keeps only the accounts that already have access to the entry, which is the set to offer when changing or revoking access. Every returned entry has `shared` set to true, and the flag is ignored when `excludeShared` is also set.
|
|
673
|
+
# @option opts [Boolean] :invited_by_me Keeps only the accounts invited by the caller when true, and only those invited by somebody else when false. Omit it to search regardless of who sent the invitation.
|
|
674
|
+
# @option opts [String] :inviter_id Keeps only the accounts invited by the account with this ID. Omit it to search regardless of who sent the invitation.
|
|
675
|
+
# @option opts [AccountSearchArea] :area The part of the portal to search in: `All`, the default, searches members and guests together, `People` leaves the guests out, and `Guests` returns guests only - and for a caller who is not a DocSpace administrator, only the guests that caller is related to.
|
|
676
|
+
# @option opts [Array<EmployeeType>] :employee_types Keeps only the accounts of the listed types, combined as alternatives. An empty list, which is the default, searches every type.
|
|
677
|
+
# @option opts [Integer] :count The size of the page. It defaults to 100, which is also the largest value the operation accepts.
|
|
678
|
+
# @option opts [Integer] :start_index The number of matches to skip before the page starts. It defaults to 0, and the total number of matches is reported in the total count of the response.
|
|
679
|
+
# @option opts [String] :filter_separator The character that splits `filterValue` into several terms, of which any one may match. Omit it to split the value on spaces instead, in which case every term has to match.
|
|
680
|
+
# @option opts [String] :filter_value The text to match against the first name, the last name and the email, case-insensitively. Omit it to get every account the caller may offer access to.
|
|
681
|
+
# @return [EmployeeFullArrayWrapper]
|
|
682
|
+
def get_users_with_folders_shared(id, opts = {})
|
|
683
|
+
data, _status_code, _headers = get_users_with_folders_shared_with_http_info(id, opts)
|
|
684
|
+
data
|
|
685
|
+
end
|
|
686
|
+
|
|
687
|
+
# Search users for a folder
|
|
688
|
+
# Returns the accounts that are relevant to the folder with the ID given in the route, and reports for each of them whether it already has access to that folder. The caller only needs read access to the folder, not the right to manage its access, but a guest may not call it at all; an ID that matches no folder answers 404. The call is read-only, works without a filter - leaving `filterValue` empty returns every matching account rather than nothing - and is paged by `count` and `startIndex`, with the number of matches in the total count of the response. Pass `excludeShared` to keep only the accounts that have no access yet, `includeShared` to keep only those that already have it, and neither to get both kinds with the `shared` field telling them apart. A DocSpace administrator additionally sees the guests that are not related to the caller. To search users and groups together, or to build an access dialog that needs the right to manage sharing, use `GET api/2.0/accounts/folder/{id}/search` instead.
|
|
689
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-users-with-folders-shared/
|
|
690
|
+
# @param id [Integer, String] The ID of the room, folder or file the search is run against, taken from the route. It is an integer for an entry stored in DocSpace and a provider-specific string for an entry in a connected third-party storage.
|
|
691
|
+
# @param [Hash] opts the optional parameters
|
|
692
|
+
# @option opts [EmployeeStatus] :employee_status Keeps only the accounts in the given state: `Active` for working accounts, `Terminated` for disabled ones and `Pending` for open invitations. Omit it to search every state.
|
|
693
|
+
# @option opts [EmployeeActivationStatus] :activation_status Keeps only the accounts whose activation is in the given state: `NotActivated`, `Activated`, `Pending` or `AutoGenerated`. Omit it to search every state.
|
|
694
|
+
# @option opts [Boolean] :exclude_shared Keeps only the accounts that do not have access to the entry yet, which is the set to offer when granting access. It takes precedence over `includeShared`, and every returned entry has `shared` set to false.
|
|
695
|
+
# @option opts [Boolean] :include_shared Keeps only the accounts that already have access to the entry, which is the set to offer when changing or revoking access. Every returned entry has `shared` set to true, and the flag is ignored when `excludeShared` is also set.
|
|
696
|
+
# @option opts [Boolean] :invited_by_me Keeps only the accounts invited by the caller when true, and only those invited by somebody else when false. Omit it to search regardless of who sent the invitation.
|
|
697
|
+
# @option opts [String] :inviter_id Keeps only the accounts invited by the account with this ID. Omit it to search regardless of who sent the invitation.
|
|
698
|
+
# @option opts [AccountSearchArea] :area The part of the portal to search in: `All`, the default, searches members and guests together, `People` leaves the guests out, and `Guests` returns guests only - and for a caller who is not a DocSpace administrator, only the guests that caller is related to.
|
|
699
|
+
# @option opts [Array<EmployeeType>] :employee_types Keeps only the accounts of the listed types, combined as alternatives. An empty list, which is the default, searches every type.
|
|
700
|
+
# @option opts [Integer] :count The size of the page. It defaults to 100, which is also the largest value the operation accepts.
|
|
701
|
+
# @option opts [Integer] :start_index The number of matches to skip before the page starts. It defaults to 0, and the total number of matches is reported in the total count of the response.
|
|
702
|
+
# @option opts [String] :filter_separator The character that splits `filterValue` into several terms, of which any one may match. Omit it to split the value on spaces instead, in which case every term has to match.
|
|
703
|
+
# @option opts [String] :filter_value The text to match against the first name, the last name and the email, case-insensitively. Omit it to get every account the caller may offer access to.
|
|
704
|
+
# @return [Array<(EmployeeFullArrayWrapper, Integer, Hash)>] EmployeeFullArrayWrapper data, response status code and response headers
|
|
705
|
+
def get_users_with_folders_shared_with_http_info(id, opts = {})
|
|
706
|
+
if @api_client.config.debugging
|
|
707
|
+
@api_client.config.logger.debug 'Calling API: People::SearchApi.get_users_with_folders_shared ...'
|
|
708
|
+
end
|
|
709
|
+
# verify the required parameter 'id' is set
|
|
710
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
711
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling People::SearchApi.get_users_with_folders_shared"
|
|
712
|
+
end
|
|
713
|
+
if @api_client.config.client_side_validation && !opts[:'count'].nil? && opts[:'count'] > 100
|
|
714
|
+
fail ArgumentError, 'invalid value for "opts[:"count"]" when calling People::SearchApi.get_users_with_folders_shared, must be smaller than or equal to 100.'
|
|
715
|
+
end
|
|
716
|
+
|
|
717
|
+
if @api_client.config.client_side_validation && !opts[:'count'].nil? && opts[:'count'] < 1
|
|
718
|
+
fail ArgumentError, 'invalid value for "opts[:"count"]" when calling People::SearchApi.get_users_with_folders_shared, must be greater than or equal to 1.'
|
|
719
|
+
end
|
|
720
|
+
|
|
721
|
+
# resource path
|
|
722
|
+
local_var_path = '/api/2.0/people/folder/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
723
|
+
|
|
724
|
+
# query parameters
|
|
725
|
+
query_params = opts[:query_params] || {}
|
|
726
|
+
query_params[:'employeeStatus'] = opts[:'employee_status'] if !opts[:'employee_status'].nil?
|
|
727
|
+
query_params[:'activationStatus'] = opts[:'activation_status'] if !opts[:'activation_status'].nil?
|
|
728
|
+
query_params[:'excludeShared'] = opts[:'exclude_shared'] if !opts[:'exclude_shared'].nil?
|
|
729
|
+
query_params[:'includeShared'] = opts[:'include_shared'] if !opts[:'include_shared'].nil?
|
|
730
|
+
query_params[:'invitedByMe'] = opts[:'invited_by_me'] if !opts[:'invited_by_me'].nil?
|
|
731
|
+
query_params[:'inviterId'] = opts[:'inviter_id'] if !opts[:'inviter_id'].nil?
|
|
732
|
+
query_params[:'area'] = opts[:'area'] if !opts[:'area'].nil?
|
|
733
|
+
query_params[:'employeeTypes'] = @api_client.build_collection_param(opts[:'employee_types'], :multi) if !opts[:'employee_types'].nil?
|
|
734
|
+
query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
|
|
735
|
+
query_params[:'startIndex'] = opts[:'start_index'] if !opts[:'start_index'].nil?
|
|
736
|
+
query_params[:'filterSeparator'] = opts[:'filter_separator'] if !opts[:'filter_separator'].nil?
|
|
737
|
+
query_params[:'filterValue'] = opts[:'filter_value'] if !opts[:'filter_value'].nil?
|
|
738
|
+
|
|
739
|
+
# header parameters
|
|
740
|
+
header_params = opts[:header_params] || {}
|
|
741
|
+
# HTTP header 'Accept' (if needed)
|
|
742
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
743
|
+
|
|
744
|
+
# form parameters
|
|
745
|
+
form_params = opts[:form_params] || {}
|
|
746
|
+
|
|
747
|
+
# http body (model)
|
|
748
|
+
post_body = opts[:debug_body]
|
|
749
|
+
|
|
750
|
+
# return_type
|
|
751
|
+
return_type = opts[:debug_return_type] || 'EmployeeFullArrayWrapper'
|
|
752
|
+
|
|
753
|
+
# auth_names
|
|
754
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
755
|
+
|
|
756
|
+
new_options = opts.merge(
|
|
757
|
+
:operation => :"People::SearchApi.get_users_with_folders_shared",
|
|
758
|
+
:header_params => header_params,
|
|
759
|
+
:query_params => query_params,
|
|
760
|
+
:form_params => form_params,
|
|
761
|
+
:body => post_body,
|
|
762
|
+
:auth_names => auth_names,
|
|
763
|
+
:return_type => return_type
|
|
764
|
+
)
|
|
765
|
+
|
|
766
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
767
|
+
if @api_client.config.debugging
|
|
768
|
+
@api_client.config.logger.debug "API called: People::SearchApi#get_users_with_folders_shared\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
769
|
+
end
|
|
770
|
+
return data, status_code, headers
|
|
771
|
+
end
|
|
772
|
+
|
|
773
|
+
# Search users for a room
|
|
774
|
+
# Returns the accounts that are relevant to the room with the ID given in the route, and reports for each of them whether it already has access to that room. The caller only needs read access to the room, not the right to manage its access, but a guest may not call it at all; an ID that matches no room answers 404. The call is read-only, works without a filter - leaving `filterValue` empty returns every matching account rather than nothing - and is paged by `count` and `startIndex`, with the number of matches in the total count of the response. Pass `excludeShared` to keep only the accounts that have no access yet, `includeShared` to keep only those that already have it, and neither to get both kinds with the `shared` field telling them apart. A DocSpace administrator additionally sees the guests that are not related to the caller. To search users and groups together, or to build an access dialog that needs the right to manage sharing, use `GET api/2.0/accounts/room/{id}/search` instead.
|
|
775
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-users-with-room-shared/
|
|
776
|
+
# @param id [Integer, String] The ID of the room, folder or file the search is run against, taken from the route. It is an integer for an entry stored in DocSpace and a provider-specific string for an entry in a connected third-party storage.
|
|
777
|
+
# @param [Hash] opts the optional parameters
|
|
778
|
+
# @option opts [EmployeeStatus] :employee_status Keeps only the accounts in the given state: `Active` for working accounts, `Terminated` for disabled ones and `Pending` for open invitations. Omit it to search every state.
|
|
779
|
+
# @option opts [EmployeeActivationStatus] :activation_status Keeps only the accounts whose activation is in the given state: `NotActivated`, `Activated`, `Pending` or `AutoGenerated`. Omit it to search every state.
|
|
780
|
+
# @option opts [Boolean] :exclude_shared Keeps only the accounts that do not have access to the entry yet, which is the set to offer when granting access. It takes precedence over `includeShared`, and every returned entry has `shared` set to false.
|
|
781
|
+
# @option opts [Boolean] :include_shared Keeps only the accounts that already have access to the entry, which is the set to offer when changing or revoking access. Every returned entry has `shared` set to true, and the flag is ignored when `excludeShared` is also set.
|
|
782
|
+
# @option opts [Boolean] :invited_by_me Keeps only the accounts invited by the caller when true, and only those invited by somebody else when false. Omit it to search regardless of who sent the invitation.
|
|
783
|
+
# @option opts [String] :inviter_id Keeps only the accounts invited by the account with this ID. Omit it to search regardless of who sent the invitation.
|
|
784
|
+
# @option opts [AccountSearchArea] :area The part of the portal to search in: `All`, the default, searches members and guests together, `People` leaves the guests out, and `Guests` returns guests only - and for a caller who is not a DocSpace administrator, only the guests that caller is related to.
|
|
785
|
+
# @option opts [Array<EmployeeType>] :employee_types Keeps only the accounts of the listed types, combined as alternatives. An empty list, which is the default, searches every type.
|
|
786
|
+
# @option opts [Integer] :count The size of the page. It defaults to 100, which is also the largest value the operation accepts.
|
|
787
|
+
# @option opts [Integer] :start_index The number of matches to skip before the page starts. It defaults to 0, and the total number of matches is reported in the total count of the response.
|
|
788
|
+
# @option opts [String] :filter_separator The character that splits `filterValue` into several terms, of which any one may match. Omit it to split the value on spaces instead, in which case every term has to match.
|
|
789
|
+
# @option opts [String] :filter_value The text to match against the first name, the last name and the email, case-insensitively. Omit it to get every account the caller may offer access to.
|
|
790
|
+
# @return [EmployeeFullArrayWrapper]
|
|
791
|
+
def get_users_with_room_shared(id, opts = {})
|
|
792
|
+
data, _status_code, _headers = get_users_with_room_shared_with_http_info(id, opts)
|
|
793
|
+
data
|
|
794
|
+
end
|
|
795
|
+
|
|
796
|
+
# Search users for a room
|
|
797
|
+
# Returns the accounts that are relevant to the room with the ID given in the route, and reports for each of them whether it already has access to that room. The caller only needs read access to the room, not the right to manage its access, but a guest may not call it at all; an ID that matches no room answers 404. The call is read-only, works without a filter - leaving `filterValue` empty returns every matching account rather than nothing - and is paged by `count` and `startIndex`, with the number of matches in the total count of the response. Pass `excludeShared` to keep only the accounts that have no access yet, `includeShared` to keep only those that already have it, and neither to get both kinds with the `shared` field telling them apart. A DocSpace administrator additionally sees the guests that are not related to the caller. To search users and groups together, or to build an access dialog that needs the right to manage sharing, use `GET api/2.0/accounts/room/{id}/search` instead.
|
|
798
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-users-with-room-shared/
|
|
799
|
+
# @param id [Integer, String] The ID of the room, folder or file the search is run against, taken from the route. It is an integer for an entry stored in DocSpace and a provider-specific string for an entry in a connected third-party storage.
|
|
800
|
+
# @param [Hash] opts the optional parameters
|
|
801
|
+
# @option opts [EmployeeStatus] :employee_status Keeps only the accounts in the given state: `Active` for working accounts, `Terminated` for disabled ones and `Pending` for open invitations. Omit it to search every state.
|
|
802
|
+
# @option opts [EmployeeActivationStatus] :activation_status Keeps only the accounts whose activation is in the given state: `NotActivated`, `Activated`, `Pending` or `AutoGenerated`. Omit it to search every state.
|
|
803
|
+
# @option opts [Boolean] :exclude_shared Keeps only the accounts that do not have access to the entry yet, which is the set to offer when granting access. It takes precedence over `includeShared`, and every returned entry has `shared` set to false.
|
|
804
|
+
# @option opts [Boolean] :include_shared Keeps only the accounts that already have access to the entry, which is the set to offer when changing or revoking access. Every returned entry has `shared` set to true, and the flag is ignored when `excludeShared` is also set.
|
|
805
|
+
# @option opts [Boolean] :invited_by_me Keeps only the accounts invited by the caller when true, and only those invited by somebody else when false. Omit it to search regardless of who sent the invitation.
|
|
806
|
+
# @option opts [String] :inviter_id Keeps only the accounts invited by the account with this ID. Omit it to search regardless of who sent the invitation.
|
|
807
|
+
# @option opts [AccountSearchArea] :area The part of the portal to search in: `All`, the default, searches members and guests together, `People` leaves the guests out, and `Guests` returns guests only - and for a caller who is not a DocSpace administrator, only the guests that caller is related to.
|
|
808
|
+
# @option opts [Array<EmployeeType>] :employee_types Keeps only the accounts of the listed types, combined as alternatives. An empty list, which is the default, searches every type.
|
|
809
|
+
# @option opts [Integer] :count The size of the page. It defaults to 100, which is also the largest value the operation accepts.
|
|
810
|
+
# @option opts [Integer] :start_index The number of matches to skip before the page starts. It defaults to 0, and the total number of matches is reported in the total count of the response.
|
|
811
|
+
# @option opts [String] :filter_separator The character that splits `filterValue` into several terms, of which any one may match. Omit it to split the value on spaces instead, in which case every term has to match.
|
|
812
|
+
# @option opts [String] :filter_value The text to match against the first name, the last name and the email, case-insensitively. Omit it to get every account the caller may offer access to.
|
|
813
|
+
# @return [Array<(EmployeeFullArrayWrapper, Integer, Hash)>] EmployeeFullArrayWrapper data, response status code and response headers
|
|
814
|
+
def get_users_with_room_shared_with_http_info(id, opts = {})
|
|
815
|
+
if @api_client.config.debugging
|
|
816
|
+
@api_client.config.logger.debug 'Calling API: People::SearchApi.get_users_with_room_shared ...'
|
|
817
|
+
end
|
|
818
|
+
# verify the required parameter 'id' is set
|
|
819
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
820
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling People::SearchApi.get_users_with_room_shared"
|
|
821
|
+
end
|
|
822
|
+
if @api_client.config.client_side_validation && !opts[:'count'].nil? && opts[:'count'] > 100
|
|
823
|
+
fail ArgumentError, 'invalid value for "opts[:"count"]" when calling People::SearchApi.get_users_with_room_shared, must be smaller than or equal to 100.'
|
|
824
|
+
end
|
|
825
|
+
|
|
826
|
+
if @api_client.config.client_side_validation && !opts[:'count'].nil? && opts[:'count'] < 1
|
|
827
|
+
fail ArgumentError, 'invalid value for "opts[:"count"]" when calling People::SearchApi.get_users_with_room_shared, must be greater than or equal to 1.'
|
|
828
|
+
end
|
|
829
|
+
|
|
830
|
+
# resource path
|
|
831
|
+
local_var_path = '/api/2.0/people/room/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
832
|
+
|
|
833
|
+
# query parameters
|
|
834
|
+
query_params = opts[:query_params] || {}
|
|
835
|
+
query_params[:'employeeStatus'] = opts[:'employee_status'] if !opts[:'employee_status'].nil?
|
|
836
|
+
query_params[:'activationStatus'] = opts[:'activation_status'] if !opts[:'activation_status'].nil?
|
|
837
|
+
query_params[:'excludeShared'] = opts[:'exclude_shared'] if !opts[:'exclude_shared'].nil?
|
|
838
|
+
query_params[:'includeShared'] = opts[:'include_shared'] if !opts[:'include_shared'].nil?
|
|
839
|
+
query_params[:'invitedByMe'] = opts[:'invited_by_me'] if !opts[:'invited_by_me'].nil?
|
|
840
|
+
query_params[:'inviterId'] = opts[:'inviter_id'] if !opts[:'inviter_id'].nil?
|
|
841
|
+
query_params[:'area'] = opts[:'area'] if !opts[:'area'].nil?
|
|
842
|
+
query_params[:'employeeTypes'] = @api_client.build_collection_param(opts[:'employee_types'], :multi) if !opts[:'employee_types'].nil?
|
|
843
|
+
query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
|
|
844
|
+
query_params[:'startIndex'] = opts[:'start_index'] if !opts[:'start_index'].nil?
|
|
845
|
+
query_params[:'filterSeparator'] = opts[:'filter_separator'] if !opts[:'filter_separator'].nil?
|
|
846
|
+
query_params[:'filterValue'] = opts[:'filter_value'] if !opts[:'filter_value'].nil?
|
|
847
|
+
|
|
848
|
+
# header parameters
|
|
849
|
+
header_params = opts[:header_params] || {}
|
|
850
|
+
# HTTP header 'Accept' (if needed)
|
|
851
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
852
|
+
|
|
853
|
+
# form parameters
|
|
854
|
+
form_params = opts[:form_params] || {}
|
|
855
|
+
|
|
856
|
+
# http body (model)
|
|
857
|
+
post_body = opts[:debug_body]
|
|
858
|
+
|
|
859
|
+
# return_type
|
|
860
|
+
return_type = opts[:debug_return_type] || 'EmployeeFullArrayWrapper'
|
|
861
|
+
|
|
862
|
+
# auth_names
|
|
863
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
864
|
+
|
|
865
|
+
new_options = opts.merge(
|
|
866
|
+
:operation => :"People::SearchApi.get_users_with_room_shared",
|
|
867
|
+
:header_params => header_params,
|
|
868
|
+
:query_params => query_params,
|
|
869
|
+
:form_params => form_params,
|
|
870
|
+
:body => post_body,
|
|
871
|
+
:auth_names => auth_names,
|
|
872
|
+
:return_type => return_type
|
|
873
|
+
)
|
|
874
|
+
|
|
875
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
876
|
+
if @api_client.config.debugging
|
|
877
|
+
@api_client.config.logger.debug "API called: People::SearchApi#get_users_with_room_shared\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
878
|
+
end
|
|
879
|
+
return data, status_code, headers
|
|
880
|
+
end
|
|
881
|
+
|
|
882
|
+
# Filter users in detail
|
|
883
|
+
# Returns a page of portal accounts selected by the full set of account filters, with the complete profile of each of them. The caller has to be a room admin, a DocSpace admin or a People module admin; a member or a guest gets 403, and a DocSpace admin additionally sees the accounts an ordinary admin does not. The call is read-only, paged by `count` and `startIndex`, ordered by `sortBy` and `sortOrder`, and reports the number of matches in the total count of the response. Filters combine as conditions that all have to hold, with three interactions worth knowing: `withoutGroup` makes `groupId` irrelevant, `employeeType` wins over `employeeTypes` when both are sent, and `area` set to `Guests` or `People` cancels the type filters that contradict it. `GET api/2.0/people/simple/filter` accepts exactly the same filters and returns the short profile instead, so use that one for pickers and lists and this one when the full profile is really needed. It is available on an unpaid portal.
|
|
884
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/search-users-by-extended-filter/
|
|
885
|
+
# @param [Hash] opts the optional parameters
|
|
886
|
+
# @option opts [EmployeeStatus] :employee_status Keeps only the accounts in the given state: `Active` for working accounts, `Terminated` for disabled ones and `Pending` for open invitations. Omit it to search every state.
|
|
887
|
+
# @option opts [String] :group_id Keeps only the members of this group, or excludes them when `excludeGroup` is true. It is ignored when `withoutGroup` is set.
|
|
888
|
+
# @option opts [EmployeeActivationStatus] :activation_status Keeps only the accounts whose activation is in the given state: `NotActivated`, `Activated`, `Pending` or `AutoGenerated`. Omit it to search every state.
|
|
889
|
+
# @option opts [EmployeeType] :employee_type Keeps only the accounts of this single type: `DocSpaceAdmin`, `RoomAdmin`, `User` or `Guest`. When it is sent it wins over `employeeTypes`, and a type that contradicts `area` is dropped.
|
|
890
|
+
# @option opts [Array<Integer>] :employee_types Keeps the accounts of any of the listed types, combined as alternatives. It is ignored when `employeeType` is also sent.
|
|
891
|
+
# @option opts [Boolean] :is_administrator Set it to true to keep only the DocSpace administrators and the module administrators. Setting it to false is the same as omitting it and does not exclude administrators.
|
|
892
|
+
# @option opts [Payments] :payments Keeps only the accounts that take a paid seat when `Paid`, or only the guests and members that do not when `Free`. Omit it to search both.
|
|
893
|
+
# @option opts [AccountLoginType] :account_login_type Keeps only the accounts that sign in this way: `SSO`, `LDAP`, or `Standart` for an ordinary portal password. Omit it to search all of them.
|
|
894
|
+
# @option opts [QuotaFilter] :quota_filter Keeps only the accounts whose storage quota is the portal default when `Default`, or set individually when `Custom`. `All`, which is the same as omitting the field, searches both.
|
|
895
|
+
# @option opts [Boolean] :without_group Set it to true to keep only the accounts that belong to no group at all, which makes `groupId` and `excludeGroup` irrelevant.
|
|
896
|
+
# @option opts [Boolean] :exclude_group Inverts `groupId`: with true the members of that group are left out instead of being the only ones kept. It has no effect without `groupId`.
|
|
897
|
+
# @option opts [Boolean] :invited_by_me Keeps only the accounts invited by the caller when true, and only those invited by somebody else when false. Omit it to search regardless of who sent the invitation.
|
|
898
|
+
# @option opts [String] :inviter_id Keeps only the accounts invited by the account with this ID. Omit it to search regardless of who sent the invitation.
|
|
899
|
+
# @option opts [AccountSearchArea] :area The part of the portal to search in: `All`, the default, searches members and guests together, `People` leaves the guests out, and `Guests` returns guests only. It also cancels the type filters that contradict it.
|
|
900
|
+
# @option opts [Integer] :count The size of the page. It defaults to 100, which is also the largest value the operation accepts.
|
|
901
|
+
# @option opts [Integer] :start_index The number of matches to skip before the page starts. It defaults to 0, and the total number of matches is reported in the total count of the response.
|
|
902
|
+
# @option opts [String] :sort_by What to order the accounts by, compared without regard to case: `FirstName`, `LastName`, `DisplayName`, `Type`, `Email`, `Department`, `UsedSpace`, `CreatedBy` or `RegistrationDate`.
|
|
903
|
+
# @option opts [SortOrder] :sort_order The direction of the ordering: `Ascending`, which is the default, or `Descending`.
|
|
904
|
+
# @option opts [String] :filter_separator The character that splits `filterValue` into several terms, of which any one may match. Omit it to split the value on spaces instead, in which case every term has to match.
|
|
905
|
+
# @option opts [String] :filter_value The text to match against the first name, the last name and the email, case-insensitively. Omit it to apply no text filter at all.
|
|
906
|
+
# @return [EmployeeFullArrayWrapper]
|
|
907
|
+
def search_users_by_extended_filter(opts = {})
|
|
908
|
+
data, _status_code, _headers = search_users_by_extended_filter_with_http_info(opts)
|
|
909
|
+
data
|
|
910
|
+
end
|
|
911
|
+
|
|
912
|
+
# Filter users in detail
|
|
913
|
+
# Returns a page of portal accounts selected by the full set of account filters, with the complete profile of each of them. The caller has to be a room admin, a DocSpace admin or a People module admin; a member or a guest gets 403, and a DocSpace admin additionally sees the accounts an ordinary admin does not. The call is read-only, paged by `count` and `startIndex`, ordered by `sortBy` and `sortOrder`, and reports the number of matches in the total count of the response. Filters combine as conditions that all have to hold, with three interactions worth knowing: `withoutGroup` makes `groupId` irrelevant, `employeeType` wins over `employeeTypes` when both are sent, and `area` set to `Guests` or `People` cancels the type filters that contradict it. `GET api/2.0/people/simple/filter` accepts exactly the same filters and returns the short profile instead, so use that one for pickers and lists and this one when the full profile is really needed. It is available on an unpaid portal.
|
|
914
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/search-users-by-extended-filter/
|
|
915
|
+
# @param [Hash] opts the optional parameters
|
|
916
|
+
# @option opts [EmployeeStatus] :employee_status Keeps only the accounts in the given state: `Active` for working accounts, `Terminated` for disabled ones and `Pending` for open invitations. Omit it to search every state.
|
|
917
|
+
# @option opts [String] :group_id Keeps only the members of this group, or excludes them when `excludeGroup` is true. It is ignored when `withoutGroup` is set.
|
|
918
|
+
# @option opts [EmployeeActivationStatus] :activation_status Keeps only the accounts whose activation is in the given state: `NotActivated`, `Activated`, `Pending` or `AutoGenerated`. Omit it to search every state.
|
|
919
|
+
# @option opts [EmployeeType] :employee_type Keeps only the accounts of this single type: `DocSpaceAdmin`, `RoomAdmin`, `User` or `Guest`. When it is sent it wins over `employeeTypes`, and a type that contradicts `area` is dropped.
|
|
920
|
+
# @option opts [Array<Integer>] :employee_types Keeps the accounts of any of the listed types, combined as alternatives. It is ignored when `employeeType` is also sent.
|
|
921
|
+
# @option opts [Boolean] :is_administrator Set it to true to keep only the DocSpace administrators and the module administrators. Setting it to false is the same as omitting it and does not exclude administrators.
|
|
922
|
+
# @option opts [Payments] :payments Keeps only the accounts that take a paid seat when `Paid`, or only the guests and members that do not when `Free`. Omit it to search both.
|
|
923
|
+
# @option opts [AccountLoginType] :account_login_type Keeps only the accounts that sign in this way: `SSO`, `LDAP`, or `Standart` for an ordinary portal password. Omit it to search all of them.
|
|
924
|
+
# @option opts [QuotaFilter] :quota_filter Keeps only the accounts whose storage quota is the portal default when `Default`, or set individually when `Custom`. `All`, which is the same as omitting the field, searches both.
|
|
925
|
+
# @option opts [Boolean] :without_group Set it to true to keep only the accounts that belong to no group at all, which makes `groupId` and `excludeGroup` irrelevant.
|
|
926
|
+
# @option opts [Boolean] :exclude_group Inverts `groupId`: with true the members of that group are left out instead of being the only ones kept. It has no effect without `groupId`.
|
|
927
|
+
# @option opts [Boolean] :invited_by_me Keeps only the accounts invited by the caller when true, and only those invited by somebody else when false. Omit it to search regardless of who sent the invitation.
|
|
928
|
+
# @option opts [String] :inviter_id Keeps only the accounts invited by the account with this ID. Omit it to search regardless of who sent the invitation.
|
|
929
|
+
# @option opts [AccountSearchArea] :area The part of the portal to search in: `All`, the default, searches members and guests together, `People` leaves the guests out, and `Guests` returns guests only. It also cancels the type filters that contradict it.
|
|
930
|
+
# @option opts [Integer] :count The size of the page. It defaults to 100, which is also the largest value the operation accepts.
|
|
931
|
+
# @option opts [Integer] :start_index The number of matches to skip before the page starts. It defaults to 0, and the total number of matches is reported in the total count of the response.
|
|
932
|
+
# @option opts [String] :sort_by What to order the accounts by, compared without regard to case: `FirstName`, `LastName`, `DisplayName`, `Type`, `Email`, `Department`, `UsedSpace`, `CreatedBy` or `RegistrationDate`.
|
|
933
|
+
# @option opts [SortOrder] :sort_order The direction of the ordering: `Ascending`, which is the default, or `Descending`.
|
|
934
|
+
# @option opts [String] :filter_separator The character that splits `filterValue` into several terms, of which any one may match. Omit it to split the value on spaces instead, in which case every term has to match.
|
|
935
|
+
# @option opts [String] :filter_value The text to match against the first name, the last name and the email, case-insensitively. Omit it to apply no text filter at all.
|
|
936
|
+
# @return [Array<(EmployeeFullArrayWrapper, Integer, Hash)>] EmployeeFullArrayWrapper data, response status code and response headers
|
|
937
|
+
def search_users_by_extended_filter_with_http_info(opts = {})
|
|
938
|
+
if @api_client.config.debugging
|
|
939
|
+
@api_client.config.logger.debug 'Calling API: People::SearchApi.search_users_by_extended_filter ...'
|
|
940
|
+
end
|
|
941
|
+
allowable_values = [0, 1, 2, 3, 4]
|
|
942
|
+
if @api_client.config.client_side_validation && opts[:'employee_types'] && !opts[:'employee_types'].all? { |item| allowable_values.include?(item) }
|
|
943
|
+
fail ArgumentError, "invalid value for \"employee_types\", must include one of #{allowable_values}"
|
|
944
|
+
end
|
|
945
|
+
if @api_client.config.client_side_validation && !opts[:'count'].nil? && opts[:'count'] > 100
|
|
946
|
+
fail ArgumentError, 'invalid value for "opts[:"count"]" when calling People::SearchApi.search_users_by_extended_filter, must be smaller than or equal to 100.'
|
|
947
|
+
end
|
|
948
|
+
|
|
949
|
+
if @api_client.config.client_side_validation && !opts[:'count'].nil? && opts[:'count'] < 1
|
|
950
|
+
fail ArgumentError, 'invalid value for "opts[:"count"]" when calling People::SearchApi.search_users_by_extended_filter, must be greater than or equal to 1.'
|
|
951
|
+
end
|
|
952
|
+
|
|
953
|
+
# resource path
|
|
954
|
+
local_var_path = '/api/2.0/people/filter'
|
|
955
|
+
|
|
956
|
+
# query parameters
|
|
957
|
+
query_params = opts[:query_params] || {}
|
|
958
|
+
query_params[:'employeeStatus'] = opts[:'employee_status'] if !opts[:'employee_status'].nil?
|
|
959
|
+
query_params[:'groupId'] = opts[:'group_id'] if !opts[:'group_id'].nil?
|
|
960
|
+
query_params[:'activationStatus'] = opts[:'activation_status'] if !opts[:'activation_status'].nil?
|
|
961
|
+
query_params[:'employeeType'] = opts[:'employee_type'] if !opts[:'employee_type'].nil?
|
|
962
|
+
query_params[:'employeeTypes'] = @api_client.build_collection_param(opts[:'employee_types'], :multi) if !opts[:'employee_types'].nil?
|
|
963
|
+
query_params[:'isAdministrator'] = opts[:'is_administrator'] if !opts[:'is_administrator'].nil?
|
|
964
|
+
query_params[:'payments'] = opts[:'payments'] if !opts[:'payments'].nil?
|
|
965
|
+
query_params[:'accountLoginType'] = opts[:'account_login_type'] if !opts[:'account_login_type'].nil?
|
|
966
|
+
query_params[:'quotaFilter'] = opts[:'quota_filter'] if !opts[:'quota_filter'].nil?
|
|
967
|
+
query_params[:'withoutGroup'] = opts[:'without_group'] if !opts[:'without_group'].nil?
|
|
968
|
+
query_params[:'excludeGroup'] = opts[:'exclude_group'] if !opts[:'exclude_group'].nil?
|
|
969
|
+
query_params[:'invitedByMe'] = opts[:'invited_by_me'] if !opts[:'invited_by_me'].nil?
|
|
970
|
+
query_params[:'inviterId'] = opts[:'inviter_id'] if !opts[:'inviter_id'].nil?
|
|
971
|
+
query_params[:'area'] = opts[:'area'] if !opts[:'area'].nil?
|
|
972
|
+
query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
|
|
973
|
+
query_params[:'startIndex'] = opts[:'start_index'] if !opts[:'start_index'].nil?
|
|
974
|
+
query_params[:'sortBy'] = opts[:'sort_by'] if !opts[:'sort_by'].nil?
|
|
975
|
+
query_params[:'sortOrder'] = opts[:'sort_order'] if !opts[:'sort_order'].nil?
|
|
976
|
+
query_params[:'filterSeparator'] = opts[:'filter_separator'] if !opts[:'filter_separator'].nil?
|
|
977
|
+
query_params[:'filterValue'] = opts[:'filter_value'] if !opts[:'filter_value'].nil?
|
|
978
|
+
|
|
979
|
+
# header parameters
|
|
980
|
+
header_params = opts[:header_params] || {}
|
|
981
|
+
# HTTP header 'Accept' (if needed)
|
|
982
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
983
|
+
|
|
984
|
+
# form parameters
|
|
985
|
+
form_params = opts[:form_params] || {}
|
|
986
|
+
|
|
987
|
+
# http body (model)
|
|
988
|
+
post_body = opts[:debug_body]
|
|
989
|
+
|
|
990
|
+
# return_type
|
|
991
|
+
return_type = opts[:debug_return_type] || 'EmployeeFullArrayWrapper'
|
|
992
|
+
|
|
993
|
+
# auth_names
|
|
994
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
995
|
+
|
|
996
|
+
new_options = opts.merge(
|
|
997
|
+
:operation => :"People::SearchApi.search_users_by_extended_filter",
|
|
998
|
+
:header_params => header_params,
|
|
999
|
+
:query_params => query_params,
|
|
1000
|
+
:form_params => form_params,
|
|
1001
|
+
:body => post_body,
|
|
1002
|
+
:auth_names => auth_names,
|
|
1003
|
+
:return_type => return_type
|
|
1004
|
+
)
|
|
1005
|
+
|
|
1006
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1007
|
+
if @api_client.config.debugging
|
|
1008
|
+
@api_client.config.logger.debug "API called: People::SearchApi#search_users_by_extended_filter\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1009
|
+
end
|
|
1010
|
+
return data, status_code, headers
|
|
1011
|
+
end
|
|
1012
|
+
|
|
1013
|
+
# Search users by query
|
|
1014
|
+
# Searches the active accounts of the portal by a term passed in the query string, and is the same search as `GET api/2.0/people/@search/{query}`, which takes the term in the path instead. Only a DocSpace administrator may call it; every other account, including a room admin, gets 403. Only accounts with the `Active` status are searched, so a pending invitation and a disabled account are never found - use `GET api/2.0/people/filter` to search across states. The call is read-only and is not paged: every match is streamed, without a total. It takes the search term and nothing else - the group filter of `GET api/2.0/people/@search/{query}` is not reachable here, because the handler forwards only `query` - so use that operation when the result has to be narrowed to one group. The answer holds full profiles, because the handler passes the request on to the operation that builds the complete profile.
|
|
1015
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/search-users-by-query/
|
|
1016
|
+
# @param [Hash] opts the optional parameters
|
|
1017
|
+
# @option opts [String] :query The term to look for. Only accounts with the `Active` status are searched, and this is the only parameter the operation reads.
|
|
1018
|
+
# @return [EmployeeFullArrayWrapper]
|
|
1019
|
+
def search_users_by_query(opts = {})
|
|
1020
|
+
data, _status_code, _headers = search_users_by_query_with_http_info(opts)
|
|
1021
|
+
data
|
|
1022
|
+
end
|
|
1023
|
+
|
|
1024
|
+
# Search users by query
|
|
1025
|
+
# Searches the active accounts of the portal by a term passed in the query string, and is the same search as `GET api/2.0/people/@search/{query}`, which takes the term in the path instead. Only a DocSpace administrator may call it; every other account, including a room admin, gets 403. Only accounts with the `Active` status are searched, so a pending invitation and a disabled account are never found - use `GET api/2.0/people/filter` to search across states. The call is read-only and is not paged: every match is streamed, without a total. It takes the search term and nothing else - the group filter of `GET api/2.0/people/@search/{query}` is not reachable here, because the handler forwards only `query` - so use that operation when the result has to be narrowed to one group. The answer holds full profiles, because the handler passes the request on to the operation that builds the complete profile.
|
|
1026
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/search-users-by-query/
|
|
1027
|
+
# @param [Hash] opts the optional parameters
|
|
1028
|
+
# @option opts [String] :query The term to look for. Only accounts with the `Active` status are searched, and this is the only parameter the operation reads.
|
|
1029
|
+
# @return [Array<(EmployeeFullArrayWrapper, Integer, Hash)>] EmployeeFullArrayWrapper data, response status code and response headers
|
|
1030
|
+
def search_users_by_query_with_http_info(opts = {})
|
|
1031
|
+
if @api_client.config.debugging
|
|
1032
|
+
@api_client.config.logger.debug 'Calling API: People::SearchApi.search_users_by_query ...'
|
|
1033
|
+
end
|
|
1034
|
+
# resource path
|
|
1035
|
+
local_var_path = '/api/2.0/people/search'
|
|
1036
|
+
|
|
1037
|
+
# query parameters
|
|
1038
|
+
query_params = opts[:query_params] || {}
|
|
1039
|
+
query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
|
|
1040
|
+
|
|
1041
|
+
# header parameters
|
|
1042
|
+
header_params = opts[:header_params] || {}
|
|
1043
|
+
# HTTP header 'Accept' (if needed)
|
|
1044
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1045
|
+
|
|
1046
|
+
# form parameters
|
|
1047
|
+
form_params = opts[:form_params] || {}
|
|
1048
|
+
|
|
1049
|
+
# http body (model)
|
|
1050
|
+
post_body = opts[:debug_body]
|
|
1051
|
+
|
|
1052
|
+
# return_type
|
|
1053
|
+
return_type = opts[:debug_return_type] || 'EmployeeFullArrayWrapper'
|
|
1054
|
+
|
|
1055
|
+
# auth_names
|
|
1056
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
1057
|
+
|
|
1058
|
+
new_options = opts.merge(
|
|
1059
|
+
:operation => :"People::SearchApi.search_users_by_query",
|
|
1060
|
+
:header_params => header_params,
|
|
1061
|
+
:query_params => query_params,
|
|
1062
|
+
:form_params => form_params,
|
|
1063
|
+
:body => post_body,
|
|
1064
|
+
:auth_names => auth_names,
|
|
1065
|
+
:return_type => return_type
|
|
1066
|
+
)
|
|
1067
|
+
|
|
1068
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1069
|
+
if @api_client.config.debugging
|
|
1070
|
+
@api_client.config.logger.debug "API called: People::SearchApi#search_users_by_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1071
|
+
end
|
|
1072
|
+
return data, status_code, headers
|
|
1073
|
+
end
|
|
1074
|
+
|
|
1075
|
+
# Search users by status filter
|
|
1076
|
+
# Searches the accounts that are in one particular state - the status is taken from the route - and whose name, user name, email or contacts contain the search term. Only a DocSpace administrator may call it; every other account, including a room admin, gets 403. The call is read-only and is not paged: it matches in memory over every account of that status and streams all of them, so it is meant for administrative lookups rather than for a user-facing list - use `GET api/2.0/people/filter` when a page and a total are needed. The term is matched as a case-insensitive substring and is required; `filterBy` set to `group` turns `text` into a group ID and keeps only the members of that group, so `text` then has to be a valid identifier. The answer holds full profiles, in no particular order.
|
|
1077
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/search-users-by-status/
|
|
1078
|
+
# @param status [EmployeeStatus] The account state to search in, taken from the route: `Active` for working accounts, `Terminated` for disabled ones, `Pending` for open invitations, or `All` for every state.
|
|
1079
|
+
# @param [Hash] opts the optional parameters
|
|
1080
|
+
# @option opts [String] :query The term to look for, matched as a case-insensitive substring of the first name, the last name, the user name, the email and the contacts. It is required in practice, because the search cannot run without it.
|
|
1081
|
+
# @option opts [String] :filter_by The only recognised value is `group`, which turns `filterValue` into a group ID and keeps only the members of that group. Any other value, and omitting the field, applies no group filter.
|
|
1082
|
+
# @option opts [String] :filter_value The group ID to keep the members of, used only when `filterBy` is `group`. It has to be a valid identifier - a group name is not accepted.
|
|
1083
|
+
# @return [EmployeeFullArrayWrapper]
|
|
1084
|
+
def search_users_by_status(status, opts = {})
|
|
1085
|
+
data, _status_code, _headers = search_users_by_status_with_http_info(status, opts)
|
|
1086
|
+
data
|
|
1087
|
+
end
|
|
1088
|
+
|
|
1089
|
+
# Search users by status filter
|
|
1090
|
+
# Searches the accounts that are in one particular state - the status is taken from the route - and whose name, user name, email or contacts contain the search term. Only a DocSpace administrator may call it; every other account, including a room admin, gets 403. The call is read-only and is not paged: it matches in memory over every account of that status and streams all of them, so it is meant for administrative lookups rather than for a user-facing list - use `GET api/2.0/people/filter` when a page and a total are needed. The term is matched as a case-insensitive substring and is required; `filterBy` set to `group` turns `text` into a group ID and keeps only the members of that group, so `text` then has to be a valid identifier. The answer holds full profiles, in no particular order.
|
|
1091
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/search-users-by-status/
|
|
1092
|
+
# @param status [EmployeeStatus] The account state to search in, taken from the route: `Active` for working accounts, `Terminated` for disabled ones, `Pending` for open invitations, or `All` for every state.
|
|
1093
|
+
# @param [Hash] opts the optional parameters
|
|
1094
|
+
# @option opts [String] :query The term to look for, matched as a case-insensitive substring of the first name, the last name, the user name, the email and the contacts. It is required in practice, because the search cannot run without it.
|
|
1095
|
+
# @option opts [String] :filter_by The only recognised value is `group`, which turns `filterValue` into a group ID and keeps only the members of that group. Any other value, and omitting the field, applies no group filter.
|
|
1096
|
+
# @option opts [String] :filter_value The group ID to keep the members of, used only when `filterBy` is `group`. It has to be a valid identifier - a group name is not accepted.
|
|
1097
|
+
# @return [Array<(EmployeeFullArrayWrapper, Integer, Hash)>] EmployeeFullArrayWrapper data, response status code and response headers
|
|
1098
|
+
def search_users_by_status_with_http_info(status, opts = {})
|
|
1099
|
+
if @api_client.config.debugging
|
|
1100
|
+
@api_client.config.logger.debug 'Calling API: People::SearchApi.search_users_by_status ...'
|
|
1101
|
+
end
|
|
1102
|
+
# verify the required parameter 'status' is set
|
|
1103
|
+
if @api_client.config.client_side_validation && status.nil?
|
|
1104
|
+
fail ArgumentError, "Missing the required parameter 'status' when calling People::SearchApi.search_users_by_status"
|
|
1105
|
+
end
|
|
1106
|
+
# resource path
|
|
1107
|
+
local_var_path = '/api/2.0/people/status/{status}/search'.sub('{' + 'status' + '}', CGI.escape(status.to_s))
|
|
1108
|
+
|
|
1109
|
+
# query parameters
|
|
1110
|
+
query_params = opts[:query_params] || {}
|
|
1111
|
+
query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
|
|
1112
|
+
query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?
|
|
1113
|
+
query_params[:'filterValue'] = opts[:'filter_value'] if !opts[:'filter_value'].nil?
|
|
1114
|
+
|
|
1115
|
+
# header parameters
|
|
1116
|
+
header_params = opts[:header_params] || {}
|
|
1117
|
+
# HTTP header 'Accept' (if needed)
|
|
1118
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1119
|
+
|
|
1120
|
+
# form parameters
|
|
1121
|
+
form_params = opts[:form_params] || {}
|
|
1122
|
+
|
|
1123
|
+
# http body (model)
|
|
1124
|
+
post_body = opts[:debug_body]
|
|
1125
|
+
|
|
1126
|
+
# return_type
|
|
1127
|
+
return_type = opts[:debug_return_type] || 'EmployeeFullArrayWrapper'
|
|
1128
|
+
|
|
1129
|
+
# auth_names
|
|
1130
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
1131
|
+
|
|
1132
|
+
new_options = opts.merge(
|
|
1133
|
+
:operation => :"People::SearchApi.search_users_by_status",
|
|
1134
|
+
:header_params => header_params,
|
|
1135
|
+
:query_params => query_params,
|
|
1136
|
+
:form_params => form_params,
|
|
1137
|
+
:body => post_body,
|
|
1138
|
+
:auth_names => auth_names,
|
|
1139
|
+
:return_type => return_type
|
|
1140
|
+
)
|
|
1141
|
+
|
|
1142
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1143
|
+
if @api_client.config.debugging
|
|
1144
|
+
@api_client.config.logger.debug "API called: People::SearchApi#search_users_by_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1145
|
+
end
|
|
1146
|
+
return data, status_code, headers
|
|
1147
|
+
end
|
|
1148
|
+
end
|
|
1149
|
+
end
|
|
1150
|
+
end
|