@openfilz-sdk/typescript-ee 1.3.5
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.
- package/.openapi-generator/FILES +167 -0
- package/.openapi-generator/VERSION +1 -0
- package/.openapi-generator/openfilz-api-generate-typescript-sdk.sha256 +1 -0
- package/.openapi-generator-ignore +23 -0
- package/LICENSE +148 -0
- package/README.md +211 -0
- package/api/audit-controller-api.ts +283 -0
- package/api/collaboration-controller-api.ts +1172 -0
- package/api/comments-api.ts +284 -0
- package/api/dashboard-api.ts +121 -0
- package/api/document-controller-api.ts +1287 -0
- package/api/document-suggestion-controller-api.ts +149 -0
- package/api/favorites-api.ts +340 -0
- package/api/file-controller-api.ts +363 -0
- package/api/folder-controller-api.ts +605 -0
- package/api/notifications-api.ts +386 -0
- package/api/scan-agent-api.ts +206 -0
- package/api/scanner-proxy-api.ts +428 -0
- package/api/search-administration-api.ts +314 -0
- package/api/settings-api.ts +196 -0
- package/api/tus-controller-api.ts +738 -0
- package/api.ts +32 -0
- package/base.ts +62 -0
- package/common.ts +127 -0
- package/configuration.ts +121 -0
- package/dist/api/audit-controller-api.d.ts +138 -0
- package/dist/api/audit-controller-api.js +275 -0
- package/dist/api/collaboration-controller-api.d.ts +534 -0
- package/dist/api/collaboration-controller-api.js +1120 -0
- package/dist/api/comments-api.d.ts +137 -0
- package/dist/api/comments-api.js +278 -0
- package/dist/api/dashboard-api.d.ts +63 -0
- package/dist/api/dashboard-api.js +125 -0
- package/dist/api/document-controller-api.d.ts +594 -0
- package/dist/api/document-controller-api.js +1219 -0
- package/dist/api/document-suggestion-controller-api.d.ts +73 -0
- package/dist/api/document-suggestion-controller-api.js +146 -0
- package/dist/api/favorites-api.d.ts +162 -0
- package/dist/api/favorites-api.js +337 -0
- package/dist/api/file-controller-api.d.ts +172 -0
- package/dist/api/file-controller-api.js +348 -0
- package/dist/api/folder-controller-api.d.ts +282 -0
- package/dist/api/folder-controller-api.js +573 -0
- package/dist/api/notifications-api.d.ts +179 -0
- package/dist/api/notifications-api.js +378 -0
- package/dist/api/scan-agent-api.d.ts +108 -0
- package/dist/api/scan-agent-api.js +208 -0
- package/dist/api/scanner-proxy-api.d.ts +202 -0
- package/dist/api/scanner-proxy-api.js +414 -0
- package/dist/api/search-administration-api.d.ts +146 -0
- package/dist/api/search-administration-api.js +311 -0
- package/dist/api/settings-api.d.ts +96 -0
- package/dist/api/settings-api.js +195 -0
- package/dist/api/tus-controller-api.d.ts +338 -0
- package/dist/api/tus-controller-api.js +712 -0
- package/dist/api.d.ts +26 -0
- package/dist/api.js +44 -0
- package/dist/base.d.ts +42 -0
- package/dist/base.js +46 -0
- package/dist/common.d.ts +34 -0
- package/dist/common.js +139 -0
- package/dist/configuration.d.ts +98 -0
- package/dist/configuration.js +44 -0
- package/dist/esm/api/audit-controller-api.d.ts +138 -0
- package/dist/esm/api/audit-controller-api.js +268 -0
- package/dist/esm/api/collaboration-controller-api.d.ts +534 -0
- package/dist/esm/api/collaboration-controller-api.js +1113 -0
- package/dist/esm/api/comments-api.d.ts +137 -0
- package/dist/esm/api/comments-api.js +271 -0
- package/dist/esm/api/dashboard-api.d.ts +63 -0
- package/dist/esm/api/dashboard-api.js +118 -0
- package/dist/esm/api/document-controller-api.d.ts +594 -0
- package/dist/esm/api/document-controller-api.js +1212 -0
- package/dist/esm/api/document-suggestion-controller-api.d.ts +73 -0
- package/dist/esm/api/document-suggestion-controller-api.js +139 -0
- package/dist/esm/api/favorites-api.d.ts +162 -0
- package/dist/esm/api/favorites-api.js +330 -0
- package/dist/esm/api/file-controller-api.d.ts +172 -0
- package/dist/esm/api/file-controller-api.js +341 -0
- package/dist/esm/api/folder-controller-api.d.ts +282 -0
- package/dist/esm/api/folder-controller-api.js +566 -0
- package/dist/esm/api/notifications-api.d.ts +179 -0
- package/dist/esm/api/notifications-api.js +371 -0
- package/dist/esm/api/scan-agent-api.d.ts +108 -0
- package/dist/esm/api/scan-agent-api.js +201 -0
- package/dist/esm/api/scanner-proxy-api.d.ts +202 -0
- package/dist/esm/api/scanner-proxy-api.js +407 -0
- package/dist/esm/api/search-administration-api.d.ts +146 -0
- package/dist/esm/api/search-administration-api.js +304 -0
- package/dist/esm/api/settings-api.d.ts +96 -0
- package/dist/esm/api/settings-api.js +188 -0
- package/dist/esm/api/tus-controller-api.d.ts +338 -0
- package/dist/esm/api/tus-controller-api.js +705 -0
- package/dist/esm/api.d.ts +26 -0
- package/dist/esm/api.js +28 -0
- package/dist/esm/base.d.ts +42 -0
- package/dist/esm/base.js +41 -0
- package/dist/esm/common.d.ts +34 -0
- package/dist/esm/common.js +126 -0
- package/dist/esm/configuration.d.ts +98 -0
- package/dist/esm/configuration.js +40 -0
- package/dist/esm/index.d.ts +14 -0
- package/dist/esm/index.js +16 -0
- package/dist/esm/models/ancestor-info.d.ts +16 -0
- package/dist/esm/models/ancestor-info.js +14 -0
- package/dist/esm/models/audit-log-details-one-of.d.ts +42 -0
- package/dist/esm/models/audit-log-details-one-of.js +14 -0
- package/dist/esm/models/audit-log-details.d.ts +14 -0
- package/dist/esm/models/audit-log-details.js +14 -0
- package/dist/esm/models/audit-log.d.ts +63 -0
- package/dist/esm/models/audit-log.js +49 -0
- package/dist/esm/models/audit-verification-result.d.ts +28 -0
- package/dist/esm/models/audit-verification-result.js +18 -0
- package/dist/esm/models/broken-link.d.ts +16 -0
- package/dist/esm/models/broken-link.js +14 -0
- package/dist/esm/models/comment-dto.d.ts +22 -0
- package/dist/esm/models/comment-dto.js +14 -0
- package/dist/esm/models/copy-audit.d.ts +17 -0
- package/dist/esm/models/copy-audit.js +14 -0
- package/dist/esm/models/copy-request.d.ts +25 -0
- package/dist/esm/models/copy-request.js +14 -0
- package/dist/esm/models/copy-response.d.ts +21 -0
- package/dist/esm/models/copy-response.js +14 -0
- package/dist/esm/models/create-blank-document-request.d.ts +29 -0
- package/dist/esm/models/create-blank-document-request.js +19 -0
- package/dist/esm/models/create-comment-request.d.ts +25 -0
- package/dist/esm/models/create-comment-request.js +14 -0
- package/dist/esm/models/create-folder-audit.d.ts +17 -0
- package/dist/esm/models/create-folder-audit.js +14 -0
- package/dist/esm/models/create-folder-request.d.ts +18 -0
- package/dist/esm/models/create-folder-request.js +14 -0
- package/dist/esm/models/create-team-request.d.ts +15 -0
- package/dist/esm/models/create-team-request.js +14 -0
- package/dist/esm/models/dashboard-statistics-response.d.ts +19 -0
- package/dist/esm/models/dashboard-statistics-response.js +14 -0
- package/dist/esm/models/delete-audit.d.ts +17 -0
- package/dist/esm/models/delete-audit.js +14 -0
- package/dist/esm/models/delete-metadata-audit.d.ts +17 -0
- package/dist/esm/models/delete-metadata-audit.js +14 -0
- package/dist/esm/models/delete-metadata-request.d.ts +17 -0
- package/dist/esm/models/delete-metadata-request.js +14 -0
- package/dist/esm/models/delete-request.d.ts +17 -0
- package/dist/esm/models/delete-request.js +14 -0
- package/dist/esm/models/delete-share-request.d.ts +18 -0
- package/dist/esm/models/delete-share-request.js +14 -0
- package/dist/esm/models/document-info.d.ts +44 -0
- package/dist/esm/models/document-info.js +17 -0
- package/dist/esm/models/document-position.d.ts +17 -0
- package/dist/esm/models/document-position.js +14 -0
- package/dist/esm/models/element-info.d.ts +16 -0
- package/dist/esm/models/element-info.js +14 -0
- package/dist/esm/models/file-type-stats.d.ts +16 -0
- package/dist/esm/models/file-type-stats.js +14 -0
- package/dist/esm/models/filter-input.d.ts +15 -0
- package/dist/esm/models/filter-input.js +14 -0
- package/dist/esm/models/folder-element-info.d.ts +30 -0
- package/dist/esm/models/folder-element-info.js +17 -0
- package/dist/esm/models/folder-response.d.ts +16 -0
- package/dist/esm/models/folder-response.js +14 -0
- package/dist/esm/models/index.d.ts +62 -0
- package/dist/esm/models/index.js +62 -0
- package/dist/esm/models/ingestion-status-dto.d.ts +22 -0
- package/dist/esm/models/ingestion-status-dto.js +14 -0
- package/dist/esm/models/move-audit.d.ts +17 -0
- package/dist/esm/models/move-audit.js +14 -0
- package/dist/esm/models/move-request.d.ts +25 -0
- package/dist/esm/models/move-request.js +14 -0
- package/dist/esm/models/notification-dto.d.ts +29 -0
- package/dist/esm/models/notification-dto.js +19 -0
- package/dist/esm/models/rename-audit.d.ts +17 -0
- package/dist/esm/models/rename-audit.js +14 -0
- package/dist/esm/models/rename-request.d.ts +14 -0
- package/dist/esm/models/rename-request.js +14 -0
- package/dist/esm/models/replace-audit.d.ts +17 -0
- package/dist/esm/models/replace-audit.js +14 -0
- package/dist/esm/models/scan-job-status-dto.d.ts +20 -0
- package/dist/esm/models/scan-job-status-dto.js +14 -0
- package/dist/esm/models/scan-request-dto.d.ts +18 -0
- package/dist/esm/models/scan-request-dto.js +14 -0
- package/dist/esm/models/scanner-info-dto.d.ts +22 -0
- package/dist/esm/models/scanner-info-dto.js +14 -0
- package/dist/esm/models/search-by-audit-log-request.d.ts +76 -0
- package/dist/esm/models/search-by-audit-log-request.js +49 -0
- package/dist/esm/models/search-by-metadata-request.d.ts +43 -0
- package/dist/esm/models/search-by-metadata-request.js +17 -0
- package/dist/esm/models/search-metadata-request.d.ts +17 -0
- package/dist/esm/models/search-metadata-request.js +14 -0
- package/dist/esm/models/settings.d.ts +19 -0
- package/dist/esm/models/settings.js +14 -0
- package/dist/esm/models/share-request.d.ts +35 -0
- package/dist/esm/models/share-request.js +18 -0
- package/dist/esm/models/share-result-error.d.ts +26 -0
- package/dist/esm/models/share-result-error.js +22 -0
- package/dist/esm/models/share-result-item.d.ts +15 -0
- package/dist/esm/models/share-result-item.js +14 -0
- package/dist/esm/models/share-result-response.d.ts +18 -0
- package/dist/esm/models/share-result-response.js +14 -0
- package/dist/esm/models/sort-input.d.ts +20 -0
- package/dist/esm/models/sort-input.js +17 -0
- package/dist/esm/models/storage-breakdown.d.ts +17 -0
- package/dist/esm/models/storage-breakdown.js +14 -0
- package/dist/esm/models/suggest.d.ts +17 -0
- package/dist/esm/models/suggest.js +14 -0
- package/dist/esm/models/team-member-info.d.ts +23 -0
- package/dist/esm/models/team-member-info.js +18 -0
- package/dist/esm/models/tus-config-response.d.ts +18 -0
- package/dist/esm/models/tus-config-response.js +14 -0
- package/dist/esm/models/tus-finalize-request.d.ts +19 -0
- package/dist/esm/models/tus-finalize-request.js +14 -0
- package/dist/esm/models/tus-upload-info.d.ts +18 -0
- package/dist/esm/models/tus-upload-info.js +14 -0
- package/dist/esm/models/update-comment-request.d.ts +21 -0
- package/dist/esm/models/update-comment-request.js +14 -0
- package/dist/esm/models/update-metadata-audit.d.ts +17 -0
- package/dist/esm/models/update-metadata-audit.js +14 -0
- package/dist/esm/models/update-metadata-request.d.ts +19 -0
- package/dist/esm/models/update-metadata-request.js +14 -0
- package/dist/esm/models/update-team-request.d.ts +15 -0
- package/dist/esm/models/update-team-request.js +14 -0
- package/dist/esm/models/update-user-request.d.ts +22 -0
- package/dist/esm/models/update-user-request.js +18 -0
- package/dist/esm/models/upload-audit.d.ts +17 -0
- package/dist/esm/models/upload-audit.js +14 -0
- package/dist/esm/models/upload-response.d.ts +19 -0
- package/dist/esm/models/upload-response.js +14 -0
- package/dist/esm/models/user-preferences-request.d.ts +15 -0
- package/dist/esm/models/user-preferences-request.js +14 -0
- package/dist/esm/models/user-registration-request.d.ts +22 -0
- package/dist/esm/models/user-registration-request.js +18 -0
- package/dist/index.d.ts +14 -0
- package/dist/index.js +32 -0
- package/dist/models/ancestor-info.d.ts +16 -0
- package/dist/models/ancestor-info.js +15 -0
- package/dist/models/audit-log-details-one-of.d.ts +42 -0
- package/dist/models/audit-log-details-one-of.js +15 -0
- package/dist/models/audit-log-details.d.ts +14 -0
- package/dist/models/audit-log-details.js +15 -0
- package/dist/models/audit-log.d.ts +63 -0
- package/dist/models/audit-log.js +52 -0
- package/dist/models/audit-verification-result.d.ts +28 -0
- package/dist/models/audit-verification-result.js +21 -0
- package/dist/models/broken-link.d.ts +16 -0
- package/dist/models/broken-link.js +15 -0
- package/dist/models/comment-dto.d.ts +22 -0
- package/dist/models/comment-dto.js +15 -0
- package/dist/models/copy-audit.d.ts +17 -0
- package/dist/models/copy-audit.js +15 -0
- package/dist/models/copy-request.d.ts +25 -0
- package/dist/models/copy-request.js +15 -0
- package/dist/models/copy-response.d.ts +21 -0
- package/dist/models/copy-response.js +15 -0
- package/dist/models/create-blank-document-request.d.ts +29 -0
- package/dist/models/create-blank-document-request.js +22 -0
- package/dist/models/create-comment-request.d.ts +25 -0
- package/dist/models/create-comment-request.js +15 -0
- package/dist/models/create-folder-audit.d.ts +17 -0
- package/dist/models/create-folder-audit.js +15 -0
- package/dist/models/create-folder-request.d.ts +18 -0
- package/dist/models/create-folder-request.js +15 -0
- package/dist/models/create-team-request.d.ts +15 -0
- package/dist/models/create-team-request.js +15 -0
- package/dist/models/dashboard-statistics-response.d.ts +19 -0
- package/dist/models/dashboard-statistics-response.js +15 -0
- package/dist/models/delete-audit.d.ts +17 -0
- package/dist/models/delete-audit.js +15 -0
- package/dist/models/delete-metadata-audit.d.ts +17 -0
- package/dist/models/delete-metadata-audit.js +15 -0
- package/dist/models/delete-metadata-request.d.ts +17 -0
- package/dist/models/delete-metadata-request.js +15 -0
- package/dist/models/delete-request.d.ts +17 -0
- package/dist/models/delete-request.js +15 -0
- package/dist/models/delete-share-request.d.ts +18 -0
- package/dist/models/delete-share-request.js +15 -0
- package/dist/models/document-info.d.ts +44 -0
- package/dist/models/document-info.js +20 -0
- package/dist/models/document-position.d.ts +17 -0
- package/dist/models/document-position.js +15 -0
- package/dist/models/element-info.d.ts +16 -0
- package/dist/models/element-info.js +15 -0
- package/dist/models/file-type-stats.d.ts +16 -0
- package/dist/models/file-type-stats.js +15 -0
- package/dist/models/filter-input.d.ts +15 -0
- package/dist/models/filter-input.js +15 -0
- package/dist/models/folder-element-info.d.ts +30 -0
- package/dist/models/folder-element-info.js +20 -0
- package/dist/models/folder-response.d.ts +16 -0
- package/dist/models/folder-response.js +15 -0
- package/dist/models/index.d.ts +62 -0
- package/dist/models/index.js +78 -0
- package/dist/models/ingestion-status-dto.d.ts +22 -0
- package/dist/models/ingestion-status-dto.js +15 -0
- package/dist/models/move-audit.d.ts +17 -0
- package/dist/models/move-audit.js +15 -0
- package/dist/models/move-request.d.ts +25 -0
- package/dist/models/move-request.js +15 -0
- package/dist/models/notification-dto.d.ts +29 -0
- package/dist/models/notification-dto.js +22 -0
- package/dist/models/rename-audit.d.ts +17 -0
- package/dist/models/rename-audit.js +15 -0
- package/dist/models/rename-request.d.ts +14 -0
- package/dist/models/rename-request.js +15 -0
- package/dist/models/replace-audit.d.ts +17 -0
- package/dist/models/replace-audit.js +15 -0
- package/dist/models/scan-job-status-dto.d.ts +20 -0
- package/dist/models/scan-job-status-dto.js +15 -0
- package/dist/models/scan-request-dto.d.ts +18 -0
- package/dist/models/scan-request-dto.js +15 -0
- package/dist/models/scanner-info-dto.d.ts +22 -0
- package/dist/models/scanner-info-dto.js +15 -0
- package/dist/models/search-by-audit-log-request.d.ts +76 -0
- package/dist/models/search-by-audit-log-request.js +52 -0
- package/dist/models/search-by-metadata-request.d.ts +43 -0
- package/dist/models/search-by-metadata-request.js +20 -0
- package/dist/models/search-metadata-request.d.ts +17 -0
- package/dist/models/search-metadata-request.js +15 -0
- package/dist/models/settings.d.ts +19 -0
- package/dist/models/settings.js +15 -0
- package/dist/models/share-request.d.ts +35 -0
- package/dist/models/share-request.js +21 -0
- package/dist/models/share-result-error.d.ts +26 -0
- package/dist/models/share-result-error.js +25 -0
- package/dist/models/share-result-item.d.ts +15 -0
- package/dist/models/share-result-item.js +15 -0
- package/dist/models/share-result-response.d.ts +18 -0
- package/dist/models/share-result-response.js +15 -0
- package/dist/models/sort-input.d.ts +20 -0
- package/dist/models/sort-input.js +20 -0
- package/dist/models/storage-breakdown.d.ts +17 -0
- package/dist/models/storage-breakdown.js +15 -0
- package/dist/models/suggest.d.ts +17 -0
- package/dist/models/suggest.js +15 -0
- package/dist/models/team-member-info.d.ts +23 -0
- package/dist/models/team-member-info.js +21 -0
- package/dist/models/tus-config-response.d.ts +18 -0
- package/dist/models/tus-config-response.js +15 -0
- package/dist/models/tus-finalize-request.d.ts +19 -0
- package/dist/models/tus-finalize-request.js +15 -0
- package/dist/models/tus-upload-info.d.ts +18 -0
- package/dist/models/tus-upload-info.js +15 -0
- package/dist/models/update-comment-request.d.ts +21 -0
- package/dist/models/update-comment-request.js +15 -0
- package/dist/models/update-metadata-audit.d.ts +17 -0
- package/dist/models/update-metadata-audit.js +15 -0
- package/dist/models/update-metadata-request.d.ts +19 -0
- package/dist/models/update-metadata-request.js +15 -0
- package/dist/models/update-team-request.d.ts +15 -0
- package/dist/models/update-team-request.js +15 -0
- package/dist/models/update-user-request.d.ts +22 -0
- package/dist/models/update-user-request.js +21 -0
- package/dist/models/upload-audit.d.ts +17 -0
- package/dist/models/upload-audit.js +15 -0
- package/dist/models/upload-response.d.ts +19 -0
- package/dist/models/upload-response.js +15 -0
- package/dist/models/user-preferences-request.d.ts +15 -0
- package/dist/models/user-preferences-request.js +15 -0
- package/dist/models/user-registration-request.d.ts +22 -0
- package/dist/models/user-registration-request.js +21 -0
- package/docs/AncestorInfo.md +24 -0
- package/docs/AuditControllerApi.md +160 -0
- package/docs/AuditLog.md +35 -0
- package/docs/AuditLogDetails.md +20 -0
- package/docs/AuditLogDetailsOneOf.md +42 -0
- package/docs/AuditVerificationResult.md +29 -0
- package/docs/BrokenLink.md +24 -0
- package/docs/CollaborationControllerApi.md +802 -0
- package/docs/CommentDTO.md +36 -0
- package/docs/CommentsApi.md +168 -0
- package/docs/CopyAudit.md +25 -0
- package/docs/CopyRequest.md +24 -0
- package/docs/CopyResponse.md +22 -0
- package/docs/CreateBlankDocumentRequest.md +24 -0
- package/docs/CreateCommentRequest.md +24 -0
- package/docs/CreateFolderAudit.md +23 -0
- package/docs/CreateFolderRequest.md +22 -0
- package/docs/CreateTeamRequest.md +22 -0
- package/docs/DashboardApi.md +52 -0
- package/docs/DashboardStatisticsResponse.md +26 -0
- package/docs/DeleteAudit.md +21 -0
- package/docs/DeleteMetadataAudit.md +21 -0
- package/docs/DeleteMetadataRequest.md +20 -0
- package/docs/DeleteRequest.md +20 -0
- package/docs/DeleteShareRequest.md +22 -0
- package/docs/DocumentControllerApi.md +834 -0
- package/docs/DocumentInfo.md +30 -0
- package/docs/DocumentPosition.md +26 -0
- package/docs/DocumentSuggestionControllerApi.md +65 -0
- package/docs/ElementInfo.md +24 -0
- package/docs/FavoritesApi.md +215 -0
- package/docs/FileControllerApi.md +222 -0
- package/docs/FileTypeStats.md +24 -0
- package/docs/FilterInput.md +22 -0
- package/docs/FolderControllerApi.md +385 -0
- package/docs/FolderElementInfo.md +24 -0
- package/docs/FolderResponse.md +24 -0
- package/docs/IngestionStatusDto.md +36 -0
- package/docs/MoveAudit.md +21 -0
- package/docs/MoveRequest.md +24 -0
- package/docs/NotificationDTO.md +36 -0
- package/docs/NotificationsApi.md +239 -0
- package/docs/RenameAudit.md +21 -0
- package/docs/RenameRequest.md +20 -0
- package/docs/ReplaceAudit.md +23 -0
- package/docs/ScanAgentApi.md +110 -0
- package/docs/ScanJobStatusDto.md +32 -0
- package/docs/ScanRequestDto.md +28 -0
- package/docs/ScannerInfoDto.md +36 -0
- package/docs/ScannerProxyApi.md +263 -0
- package/docs/SearchAdministrationApi.md +187 -0
- package/docs/SearchByAuditLogRequest.md +29 -0
- package/docs/SearchByMetadataRequest.md +29 -0
- package/docs/SearchMetadataRequest.md +20 -0
- package/docs/Settings.md +30 -0
- package/docs/SettingsApi.md +105 -0
- package/docs/ShareRequest.md +26 -0
- package/docs/ShareResultError.md +24 -0
- package/docs/ShareResultItem.md +22 -0
- package/docs/ShareResultResponse.md +24 -0
- package/docs/SortInput.md +22 -0
- package/docs/StorageBreakdown.md +24 -0
- package/docs/Suggest.md +26 -0
- package/docs/TeamMemberInfo.md +26 -0
- package/docs/TusConfigResponse.md +28 -0
- package/docs/TusControllerApi.md +493 -0
- package/docs/TusFinalizeRequest.md +26 -0
- package/docs/TusUploadInfo.md +28 -0
- package/docs/UpdateCommentRequest.md +22 -0
- package/docs/UpdateMetadataAudit.md +21 -0
- package/docs/UpdateMetadataRequest.md +20 -0
- package/docs/UpdateTeamRequest.md +22 -0
- package/docs/UpdateUserRequest.md +24 -0
- package/docs/UploadAudit.md +25 -0
- package/docs/UploadResponse.md +30 -0
- package/docs/UserPreferencesRequest.md +22 -0
- package/docs/UserRegistrationRequest.md +24 -0
- package/git_push.sh +57 -0
- package/graphql/analytics.graphqls +101 -0
- package/graphql/comment.graphqls +33 -0
- package/graphql/document-search.graphqls +44 -0
- package/graphql/document.graphqls +116 -0
- package/graphql/share.graphqls +168 -0
- package/index.ts +18 -0
- package/models/ancestor-info.ts +22 -0
- package/models/audit-log-details-one-of.ts +70 -0
- package/models/audit-log-details.ts +20 -0
- package/models/audit-log.ts +75 -0
- package/models/audit-verification-result.ts +39 -0
- package/models/broken-link.ts +22 -0
- package/models/comment-dto.ts +28 -0
- package/models/copy-audit.ts +26 -0
- package/models/copy-request.ts +31 -0
- package/models/copy-response.ts +27 -0
- package/models/create-blank-document-request.ts +38 -0
- package/models/create-comment-request.ts +31 -0
- package/models/create-folder-audit.ts +29 -0
- package/models/create-folder-request.ts +24 -0
- package/models/create-team-request.ts +21 -0
- package/models/dashboard-statistics-response.ts +29 -0
- package/models/delete-audit.ts +26 -0
- package/models/delete-metadata-audit.ts +26 -0
- package/models/delete-metadata-request.ts +23 -0
- package/models/delete-request.ts +23 -0
- package/models/delete-share-request.ts +24 -0
- package/models/document-info.ts +51 -0
- package/models/document-position.ts +23 -0
- package/models/element-info.ts +22 -0
- package/models/file-type-stats.ts +22 -0
- package/models/filter-input.ts +21 -0
- package/models/folder-element-info.ts +39 -0
- package/models/folder-response.ts +22 -0
- package/models/index.ts +62 -0
- package/models/ingestion-status-dto.ts +28 -0
- package/models/move-audit.ts +26 -0
- package/models/move-request.ts +31 -0
- package/models/notification-dto.ts +38 -0
- package/models/rename-audit.ts +26 -0
- package/models/rename-request.ts +20 -0
- package/models/replace-audit.ts +26 -0
- package/models/scan-job-status-dto.ts +26 -0
- package/models/scan-request-dto.ts +24 -0
- package/models/scanner-info-dto.ts +28 -0
- package/models/search-by-audit-log-request.ts +84 -0
- package/models/search-by-metadata-request.ts +50 -0
- package/models/search-metadata-request.ts +23 -0
- package/models/settings.ts +25 -0
- package/models/share-request.ts +44 -0
- package/models/share-result-error.ts +35 -0
- package/models/share-result-item.ts +21 -0
- package/models/share-result-response.ts +28 -0
- package/models/sort-input.ts +29 -0
- package/models/storage-breakdown.ts +25 -0
- package/models/suggest.ts +23 -0
- package/models/team-member-info.ts +32 -0
- package/models/tus-config-response.ts +24 -0
- package/models/tus-finalize-request.ts +23 -0
- package/models/tus-upload-info.ts +24 -0
- package/models/update-comment-request.ts +27 -0
- package/models/update-metadata-audit.ts +26 -0
- package/models/update-metadata-request.ts +23 -0
- package/models/update-team-request.ts +21 -0
- package/models/update-user-request.ts +31 -0
- package/models/upload-audit.ts +26 -0
- package/models/upload-response.ts +25 -0
- package/models/user-preferences-request.ts +21 -0
- package/models/user-registration-request.ts +31 -0
- package/package.json +33 -0
- package/tsconfig.esm.json +7 -0
- package/tsconfig.json +18 -0
|
@@ -0,0 +1,534 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* openfilz-api
|
|
3
|
+
* API for Document Management System
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { Configuration } from '../configuration';
|
|
13
|
+
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
|
+
import { type RequestArgs, BaseAPI } from '../base';
|
|
15
|
+
import type { CreateTeamRequest } from '../models';
|
|
16
|
+
import type { DeleteShareRequest } from '../models';
|
|
17
|
+
import type { ShareRequest } from '../models';
|
|
18
|
+
import type { ShareResultResponse } from '../models';
|
|
19
|
+
import type { TeamMemberInfo } from '../models';
|
|
20
|
+
import type { UpdateTeamRequest } from '../models';
|
|
21
|
+
import type { UpdateUserRequest } from '../models';
|
|
22
|
+
import type { UserRegistrationRequest } from '../models';
|
|
23
|
+
/**
|
|
24
|
+
* CollaborationControllerApi - axios parameter creator
|
|
25
|
+
*/
|
|
26
|
+
export declare const CollaborationControllerApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
27
|
+
/**
|
|
28
|
+
* Accepts a share request: creates the share and deletes the request. Accessible only by users with EDIT_SHARE role.
|
|
29
|
+
* @summary Accept a share request
|
|
30
|
+
* @param {string} id
|
|
31
|
+
* @param {*} [options] Override http request option.
|
|
32
|
+
* @throws {RequiredError}
|
|
33
|
+
*/
|
|
34
|
+
acceptShareRequest: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35
|
+
/**
|
|
36
|
+
* Adds users to a team. Requires ADMIN_USERS role.
|
|
37
|
+
* @summary Add team members
|
|
38
|
+
* @param {string} teamId
|
|
39
|
+
* @param {Array<string>} requestBody
|
|
40
|
+
* @param {*} [options] Override http request option.
|
|
41
|
+
* @throws {RequiredError}
|
|
42
|
+
*/
|
|
43
|
+
addTeamMembers: (teamId: string, requestBody: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
44
|
+
/**
|
|
45
|
+
* Creates new Shared document(s) with users. Returns 200 when all items are processed successfully. Returns 207 when there is a mix of successes, share requests, and/or errors. Error codes in response: - SHARE_ERR_USER_DEACTIVATED: Cannot share with a deactivated user in read-only mode - SHARE_ERR_USER_NOT_LICENSED: User must have a license to be shared with in editor or commenter mode - SHARE_ERR_PARENT_AND_CHILD: A folder and its children cannot both be in the share list - SHARE_ERR_ALREADY_EXISTS: A share already exists for this document and user
|
|
46
|
+
* @summary Create Share for document(s)
|
|
47
|
+
* @param {ShareRequest} shareRequest
|
|
48
|
+
* @param {*} [options] Override http request option.
|
|
49
|
+
* @throws {RequiredError}
|
|
50
|
+
*/
|
|
51
|
+
createSharedDocuments: (shareRequest: ShareRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
52
|
+
/**
|
|
53
|
+
* Creates a new team. Requires ADMIN_USERS role.
|
|
54
|
+
* @summary Create a team
|
|
55
|
+
* @param {CreateTeamRequest} createTeamRequest
|
|
56
|
+
* @param {*} [options] Override http request option.
|
|
57
|
+
* @throws {RequiredError}
|
|
58
|
+
*/
|
|
59
|
+
createTeam: (createTeamRequest: CreateTeamRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
60
|
+
/**
|
|
61
|
+
* Create a new user to share documents with
|
|
62
|
+
* @summary Create a new user
|
|
63
|
+
* @param {UserRegistrationRequest} userRegistrationRequest
|
|
64
|
+
* @param {*} [options] Override http request option.
|
|
65
|
+
* @throws {RequiredError}
|
|
66
|
+
*/
|
|
67
|
+
createUser: (userRegistrationRequest: UserRegistrationRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
68
|
+
/**
|
|
69
|
+
* Deactivates a user. Requires ADMIN_USERS role.
|
|
70
|
+
* @summary Deactivate a user
|
|
71
|
+
* @param {string} userId
|
|
72
|
+
* @param {*} [options] Override http request option.
|
|
73
|
+
* @throws {RequiredError}
|
|
74
|
+
*/
|
|
75
|
+
deactivateUser: (userId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
76
|
+
/**
|
|
77
|
+
* Deletes existing Shared document(s) with users. Returns 200 when all items are processed successfully. Returns 207 when there is a mix of successes, share requests, and/or errors. Error codes in response: - SHARE_ERR_NOT_ALREADY_SHARED: No existing share found for this document and user
|
|
78
|
+
* @summary Delete Share for document(s)
|
|
79
|
+
* @param {DeleteShareRequest} deleteShareRequest
|
|
80
|
+
* @param {*} [options] Override http request option.
|
|
81
|
+
* @throws {RequiredError}
|
|
82
|
+
*/
|
|
83
|
+
deleteSharedDocuments: (deleteShareRequest: DeleteShareRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
84
|
+
/**
|
|
85
|
+
* Deletes a team. Requires ADMIN_USERS role.
|
|
86
|
+
* @summary Delete a team
|
|
87
|
+
* @param {string} teamId
|
|
88
|
+
* @param {*} [options] Override http request option.
|
|
89
|
+
* @throws {RequiredError}
|
|
90
|
+
*/
|
|
91
|
+
deleteTeam: (teamId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
92
|
+
/**
|
|
93
|
+
* Lists all members of a team. Requires ADMIN_USERS role.
|
|
94
|
+
* @summary Get team members
|
|
95
|
+
* @param {string} teamId
|
|
96
|
+
* @param {*} [options] Override http request option.
|
|
97
|
+
* @throws {RequiredError}
|
|
98
|
+
*/
|
|
99
|
+
getTeamMembers: (teamId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
100
|
+
/**
|
|
101
|
+
* Confirms the current user exists in the local database. User sync happens during JWT authentication, so this endpoint simply confirms authentication was successful.
|
|
102
|
+
* @summary Check user status
|
|
103
|
+
* @param {*} [options] Override http request option.
|
|
104
|
+
* @throws {RequiredError}
|
|
105
|
+
*/
|
|
106
|
+
getUserStatus: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
107
|
+
/**
|
|
108
|
+
* Rejects and deletes a share request. Accessible only by users with EDIT_SHARE role.
|
|
109
|
+
* @summary Reject a share request
|
|
110
|
+
* @param {string} id
|
|
111
|
+
* @param {*} [options] Override http request option.
|
|
112
|
+
* @throws {RequiredError}
|
|
113
|
+
*/
|
|
114
|
+
rejectShareRequest: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
115
|
+
/**
|
|
116
|
+
* Removes users from a team. Requires ADMIN_USERS role.
|
|
117
|
+
* @summary Remove team members
|
|
118
|
+
* @param {string} teamId
|
|
119
|
+
* @param {Array<string>} requestBody
|
|
120
|
+
* @param {*} [options] Override http request option.
|
|
121
|
+
* @throws {RequiredError}
|
|
122
|
+
*/
|
|
123
|
+
removeTeamMembers: (teamId: string, requestBody: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
124
|
+
/**
|
|
125
|
+
* Updates existing Shared document(s) with users. Returns 200 when all items are processed successfully. Returns 207 when there is a mix of successes, share requests, and/or errors. Error codes in response: - SHARE_ERR_USER_DEACTIVATED: Cannot share with a deactivated user in read-only mode - SHARE_ERR_USER_NOT_LICENSED: User must have a license to be shared with in editor or commenter mode - SHARE_ERR_PARENT_AND_CHILD: A folder and its children cannot both be in the share list - SHARE_ERR_NOT_ALREADY_SHARED: No existing share found for this document and user
|
|
126
|
+
* @summary Update Share for document(s)
|
|
127
|
+
* @param {ShareRequest} shareRequest
|
|
128
|
+
* @param {*} [options] Override http request option.
|
|
129
|
+
* @throws {RequiredError}
|
|
130
|
+
*/
|
|
131
|
+
updateSharedDocuments: (shareRequest: ShareRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
132
|
+
/**
|
|
133
|
+
* Updates team name and email. Requires ADMIN_USERS role.
|
|
134
|
+
* @summary Update a team
|
|
135
|
+
* @param {string} teamId
|
|
136
|
+
* @param {UpdateTeamRequest} updateTeamRequest
|
|
137
|
+
* @param {*} [options] Override http request option.
|
|
138
|
+
* @throws {RequiredError}
|
|
139
|
+
*/
|
|
140
|
+
updateTeam: (teamId: string, updateTeamRequest: UpdateTeamRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
141
|
+
/**
|
|
142
|
+
* Updates user name, email and/or status. Requires ADMIN_USERS role. Status changes also require ASSIGN_LICENSES.
|
|
143
|
+
* @summary Update a user
|
|
144
|
+
* @param {string} userId
|
|
145
|
+
* @param {UpdateUserRequest} updateUserRequest
|
|
146
|
+
* @param {*} [options] Override http request option.
|
|
147
|
+
* @throws {RequiredError}
|
|
148
|
+
*/
|
|
149
|
+
updateUser: (userId: string, updateUserRequest: UpdateUserRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
150
|
+
};
|
|
151
|
+
/**
|
|
152
|
+
* CollaborationControllerApi - functional programming interface
|
|
153
|
+
*/
|
|
154
|
+
export declare const CollaborationControllerApiFp: (configuration?: Configuration) => {
|
|
155
|
+
/**
|
|
156
|
+
* Accepts a share request: creates the share and deletes the request. Accessible only by users with EDIT_SHARE role.
|
|
157
|
+
* @summary Accept a share request
|
|
158
|
+
* @param {string} id
|
|
159
|
+
* @param {*} [options] Override http request option.
|
|
160
|
+
* @throws {RequiredError}
|
|
161
|
+
*/
|
|
162
|
+
acceptShareRequest(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<number>>;
|
|
163
|
+
/**
|
|
164
|
+
* Adds users to a team. Requires ADMIN_USERS role.
|
|
165
|
+
* @summary Add team members
|
|
166
|
+
* @param {string} teamId
|
|
167
|
+
* @param {Array<string>} requestBody
|
|
168
|
+
* @param {*} [options] Override http request option.
|
|
169
|
+
* @throws {RequiredError}
|
|
170
|
+
*/
|
|
171
|
+
addTeamMembers(teamId: string, requestBody: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
172
|
+
/**
|
|
173
|
+
* Creates new Shared document(s) with users. Returns 200 when all items are processed successfully. Returns 207 when there is a mix of successes, share requests, and/or errors. Error codes in response: - SHARE_ERR_USER_DEACTIVATED: Cannot share with a deactivated user in read-only mode - SHARE_ERR_USER_NOT_LICENSED: User must have a license to be shared with in editor or commenter mode - SHARE_ERR_PARENT_AND_CHILD: A folder and its children cannot both be in the share list - SHARE_ERR_ALREADY_EXISTS: A share already exists for this document and user
|
|
174
|
+
* @summary Create Share for document(s)
|
|
175
|
+
* @param {ShareRequest} shareRequest
|
|
176
|
+
* @param {*} [options] Override http request option.
|
|
177
|
+
* @throws {RequiredError}
|
|
178
|
+
*/
|
|
179
|
+
createSharedDocuments(shareRequest: ShareRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShareResultResponse>>;
|
|
180
|
+
/**
|
|
181
|
+
* Creates a new team. Requires ADMIN_USERS role.
|
|
182
|
+
* @summary Create a team
|
|
183
|
+
* @param {CreateTeamRequest} createTeamRequest
|
|
184
|
+
* @param {*} [options] Override http request option.
|
|
185
|
+
* @throws {RequiredError}
|
|
186
|
+
*/
|
|
187
|
+
createTeam(createTeamRequest: CreateTeamRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
188
|
+
/**
|
|
189
|
+
* Create a new user to share documents with
|
|
190
|
+
* @summary Create a new user
|
|
191
|
+
* @param {UserRegistrationRequest} userRegistrationRequest
|
|
192
|
+
* @param {*} [options] Override http request option.
|
|
193
|
+
* @throws {RequiredError}
|
|
194
|
+
*/
|
|
195
|
+
createUser(userRegistrationRequest: UserRegistrationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
196
|
+
/**
|
|
197
|
+
* Deactivates a user. Requires ADMIN_USERS role.
|
|
198
|
+
* @summary Deactivate a user
|
|
199
|
+
* @param {string} userId
|
|
200
|
+
* @param {*} [options] Override http request option.
|
|
201
|
+
* @throws {RequiredError}
|
|
202
|
+
*/
|
|
203
|
+
deactivateUser(userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
204
|
+
/**
|
|
205
|
+
* Deletes existing Shared document(s) with users. Returns 200 when all items are processed successfully. Returns 207 when there is a mix of successes, share requests, and/or errors. Error codes in response: - SHARE_ERR_NOT_ALREADY_SHARED: No existing share found for this document and user
|
|
206
|
+
* @summary Delete Share for document(s)
|
|
207
|
+
* @param {DeleteShareRequest} deleteShareRequest
|
|
208
|
+
* @param {*} [options] Override http request option.
|
|
209
|
+
* @throws {RequiredError}
|
|
210
|
+
*/
|
|
211
|
+
deleteSharedDocuments(deleteShareRequest: DeleteShareRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShareResultResponse>>;
|
|
212
|
+
/**
|
|
213
|
+
* Deletes a team. Requires ADMIN_USERS role.
|
|
214
|
+
* @summary Delete a team
|
|
215
|
+
* @param {string} teamId
|
|
216
|
+
* @param {*} [options] Override http request option.
|
|
217
|
+
* @throws {RequiredError}
|
|
218
|
+
*/
|
|
219
|
+
deleteTeam(teamId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
220
|
+
/**
|
|
221
|
+
* Lists all members of a team. Requires ADMIN_USERS role.
|
|
222
|
+
* @summary Get team members
|
|
223
|
+
* @param {string} teamId
|
|
224
|
+
* @param {*} [options] Override http request option.
|
|
225
|
+
* @throws {RequiredError}
|
|
226
|
+
*/
|
|
227
|
+
getTeamMembers(teamId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TeamMemberInfo>>>;
|
|
228
|
+
/**
|
|
229
|
+
* Confirms the current user exists in the local database. User sync happens during JWT authentication, so this endpoint simply confirms authentication was successful.
|
|
230
|
+
* @summary Check user status
|
|
231
|
+
* @param {*} [options] Override http request option.
|
|
232
|
+
* @throws {RequiredError}
|
|
233
|
+
*/
|
|
234
|
+
getUserStatus(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
235
|
+
/**
|
|
236
|
+
* Rejects and deletes a share request. Accessible only by users with EDIT_SHARE role.
|
|
237
|
+
* @summary Reject a share request
|
|
238
|
+
* @param {string} id
|
|
239
|
+
* @param {*} [options] Override http request option.
|
|
240
|
+
* @throws {RequiredError}
|
|
241
|
+
*/
|
|
242
|
+
rejectShareRequest(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
243
|
+
/**
|
|
244
|
+
* Removes users from a team. Requires ADMIN_USERS role.
|
|
245
|
+
* @summary Remove team members
|
|
246
|
+
* @param {string} teamId
|
|
247
|
+
* @param {Array<string>} requestBody
|
|
248
|
+
* @param {*} [options] Override http request option.
|
|
249
|
+
* @throws {RequiredError}
|
|
250
|
+
*/
|
|
251
|
+
removeTeamMembers(teamId: string, requestBody: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
252
|
+
/**
|
|
253
|
+
* Updates existing Shared document(s) with users. Returns 200 when all items are processed successfully. Returns 207 when there is a mix of successes, share requests, and/or errors. Error codes in response: - SHARE_ERR_USER_DEACTIVATED: Cannot share with a deactivated user in read-only mode - SHARE_ERR_USER_NOT_LICENSED: User must have a license to be shared with in editor or commenter mode - SHARE_ERR_PARENT_AND_CHILD: A folder and its children cannot both be in the share list - SHARE_ERR_NOT_ALREADY_SHARED: No existing share found for this document and user
|
|
254
|
+
* @summary Update Share for document(s)
|
|
255
|
+
* @param {ShareRequest} shareRequest
|
|
256
|
+
* @param {*} [options] Override http request option.
|
|
257
|
+
* @throws {RequiredError}
|
|
258
|
+
*/
|
|
259
|
+
updateSharedDocuments(shareRequest: ShareRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShareResultResponse>>;
|
|
260
|
+
/**
|
|
261
|
+
* Updates team name and email. Requires ADMIN_USERS role.
|
|
262
|
+
* @summary Update a team
|
|
263
|
+
* @param {string} teamId
|
|
264
|
+
* @param {UpdateTeamRequest} updateTeamRequest
|
|
265
|
+
* @param {*} [options] Override http request option.
|
|
266
|
+
* @throws {RequiredError}
|
|
267
|
+
*/
|
|
268
|
+
updateTeam(teamId: string, updateTeamRequest: UpdateTeamRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
269
|
+
/**
|
|
270
|
+
* Updates user name, email and/or status. Requires ADMIN_USERS role. Status changes also require ASSIGN_LICENSES.
|
|
271
|
+
* @summary Update a user
|
|
272
|
+
* @param {string} userId
|
|
273
|
+
* @param {UpdateUserRequest} updateUserRequest
|
|
274
|
+
* @param {*} [options] Override http request option.
|
|
275
|
+
* @throws {RequiredError}
|
|
276
|
+
*/
|
|
277
|
+
updateUser(userId: string, updateUserRequest: UpdateUserRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
278
|
+
};
|
|
279
|
+
/**
|
|
280
|
+
* CollaborationControllerApi - factory interface
|
|
281
|
+
*/
|
|
282
|
+
export declare const CollaborationControllerApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
283
|
+
/**
|
|
284
|
+
* Accepts a share request: creates the share and deletes the request. Accessible only by users with EDIT_SHARE role.
|
|
285
|
+
* @summary Accept a share request
|
|
286
|
+
* @param {string} id
|
|
287
|
+
* @param {*} [options] Override http request option.
|
|
288
|
+
* @throws {RequiredError}
|
|
289
|
+
*/
|
|
290
|
+
acceptShareRequest(id: string, options?: RawAxiosRequestConfig): AxiosPromise<number>;
|
|
291
|
+
/**
|
|
292
|
+
* Adds users to a team. Requires ADMIN_USERS role.
|
|
293
|
+
* @summary Add team members
|
|
294
|
+
* @param {string} teamId
|
|
295
|
+
* @param {Array<string>} requestBody
|
|
296
|
+
* @param {*} [options] Override http request option.
|
|
297
|
+
* @throws {RequiredError}
|
|
298
|
+
*/
|
|
299
|
+
addTeamMembers(teamId: string, requestBody: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
300
|
+
/**
|
|
301
|
+
* Creates new Shared document(s) with users. Returns 200 when all items are processed successfully. Returns 207 when there is a mix of successes, share requests, and/or errors. Error codes in response: - SHARE_ERR_USER_DEACTIVATED: Cannot share with a deactivated user in read-only mode - SHARE_ERR_USER_NOT_LICENSED: User must have a license to be shared with in editor or commenter mode - SHARE_ERR_PARENT_AND_CHILD: A folder and its children cannot both be in the share list - SHARE_ERR_ALREADY_EXISTS: A share already exists for this document and user
|
|
302
|
+
* @summary Create Share for document(s)
|
|
303
|
+
* @param {ShareRequest} shareRequest
|
|
304
|
+
* @param {*} [options] Override http request option.
|
|
305
|
+
* @throws {RequiredError}
|
|
306
|
+
*/
|
|
307
|
+
createSharedDocuments(shareRequest: ShareRequest, options?: RawAxiosRequestConfig): AxiosPromise<ShareResultResponse>;
|
|
308
|
+
/**
|
|
309
|
+
* Creates a new team. Requires ADMIN_USERS role.
|
|
310
|
+
* @summary Create a team
|
|
311
|
+
* @param {CreateTeamRequest} createTeamRequest
|
|
312
|
+
* @param {*} [options] Override http request option.
|
|
313
|
+
* @throws {RequiredError}
|
|
314
|
+
*/
|
|
315
|
+
createTeam(createTeamRequest: CreateTeamRequest, options?: RawAxiosRequestConfig): AxiosPromise<string>;
|
|
316
|
+
/**
|
|
317
|
+
* Create a new user to share documents with
|
|
318
|
+
* @summary Create a new user
|
|
319
|
+
* @param {UserRegistrationRequest} userRegistrationRequest
|
|
320
|
+
* @param {*} [options] Override http request option.
|
|
321
|
+
* @throws {RequiredError}
|
|
322
|
+
*/
|
|
323
|
+
createUser(userRegistrationRequest: UserRegistrationRequest, options?: RawAxiosRequestConfig): AxiosPromise<string>;
|
|
324
|
+
/**
|
|
325
|
+
* Deactivates a user. Requires ADMIN_USERS role.
|
|
326
|
+
* @summary Deactivate a user
|
|
327
|
+
* @param {string} userId
|
|
328
|
+
* @param {*} [options] Override http request option.
|
|
329
|
+
* @throws {RequiredError}
|
|
330
|
+
*/
|
|
331
|
+
deactivateUser(userId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
332
|
+
/**
|
|
333
|
+
* Deletes existing Shared document(s) with users. Returns 200 when all items are processed successfully. Returns 207 when there is a mix of successes, share requests, and/or errors. Error codes in response: - SHARE_ERR_NOT_ALREADY_SHARED: No existing share found for this document and user
|
|
334
|
+
* @summary Delete Share for document(s)
|
|
335
|
+
* @param {DeleteShareRequest} deleteShareRequest
|
|
336
|
+
* @param {*} [options] Override http request option.
|
|
337
|
+
* @throws {RequiredError}
|
|
338
|
+
*/
|
|
339
|
+
deleteSharedDocuments(deleteShareRequest: DeleteShareRequest, options?: RawAxiosRequestConfig): AxiosPromise<ShareResultResponse>;
|
|
340
|
+
/**
|
|
341
|
+
* Deletes a team. Requires ADMIN_USERS role.
|
|
342
|
+
* @summary Delete a team
|
|
343
|
+
* @param {string} teamId
|
|
344
|
+
* @param {*} [options] Override http request option.
|
|
345
|
+
* @throws {RequiredError}
|
|
346
|
+
*/
|
|
347
|
+
deleteTeam(teamId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
348
|
+
/**
|
|
349
|
+
* Lists all members of a team. Requires ADMIN_USERS role.
|
|
350
|
+
* @summary Get team members
|
|
351
|
+
* @param {string} teamId
|
|
352
|
+
* @param {*} [options] Override http request option.
|
|
353
|
+
* @throws {RequiredError}
|
|
354
|
+
*/
|
|
355
|
+
getTeamMembers(teamId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<TeamMemberInfo>>;
|
|
356
|
+
/**
|
|
357
|
+
* Confirms the current user exists in the local database. User sync happens during JWT authentication, so this endpoint simply confirms authentication was successful.
|
|
358
|
+
* @summary Check user status
|
|
359
|
+
* @param {*} [options] Override http request option.
|
|
360
|
+
* @throws {RequiredError}
|
|
361
|
+
*/
|
|
362
|
+
getUserStatus(options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
363
|
+
/**
|
|
364
|
+
* Rejects and deletes a share request. Accessible only by users with EDIT_SHARE role.
|
|
365
|
+
* @summary Reject a share request
|
|
366
|
+
* @param {string} id
|
|
367
|
+
* @param {*} [options] Override http request option.
|
|
368
|
+
* @throws {RequiredError}
|
|
369
|
+
*/
|
|
370
|
+
rejectShareRequest(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
371
|
+
/**
|
|
372
|
+
* Removes users from a team. Requires ADMIN_USERS role.
|
|
373
|
+
* @summary Remove team members
|
|
374
|
+
* @param {string} teamId
|
|
375
|
+
* @param {Array<string>} requestBody
|
|
376
|
+
* @param {*} [options] Override http request option.
|
|
377
|
+
* @throws {RequiredError}
|
|
378
|
+
*/
|
|
379
|
+
removeTeamMembers(teamId: string, requestBody: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
380
|
+
/**
|
|
381
|
+
* Updates existing Shared document(s) with users. Returns 200 when all items are processed successfully. Returns 207 when there is a mix of successes, share requests, and/or errors. Error codes in response: - SHARE_ERR_USER_DEACTIVATED: Cannot share with a deactivated user in read-only mode - SHARE_ERR_USER_NOT_LICENSED: User must have a license to be shared with in editor or commenter mode - SHARE_ERR_PARENT_AND_CHILD: A folder and its children cannot both be in the share list - SHARE_ERR_NOT_ALREADY_SHARED: No existing share found for this document and user
|
|
382
|
+
* @summary Update Share for document(s)
|
|
383
|
+
* @param {ShareRequest} shareRequest
|
|
384
|
+
* @param {*} [options] Override http request option.
|
|
385
|
+
* @throws {RequiredError}
|
|
386
|
+
*/
|
|
387
|
+
updateSharedDocuments(shareRequest: ShareRequest, options?: RawAxiosRequestConfig): AxiosPromise<ShareResultResponse>;
|
|
388
|
+
/**
|
|
389
|
+
* Updates team name and email. Requires ADMIN_USERS role.
|
|
390
|
+
* @summary Update a team
|
|
391
|
+
* @param {string} teamId
|
|
392
|
+
* @param {UpdateTeamRequest} updateTeamRequest
|
|
393
|
+
* @param {*} [options] Override http request option.
|
|
394
|
+
* @throws {RequiredError}
|
|
395
|
+
*/
|
|
396
|
+
updateTeam(teamId: string, updateTeamRequest: UpdateTeamRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
397
|
+
/**
|
|
398
|
+
* Updates user name, email and/or status. Requires ADMIN_USERS role. Status changes also require ASSIGN_LICENSES.
|
|
399
|
+
* @summary Update a user
|
|
400
|
+
* @param {string} userId
|
|
401
|
+
* @param {UpdateUserRequest} updateUserRequest
|
|
402
|
+
* @param {*} [options] Override http request option.
|
|
403
|
+
* @throws {RequiredError}
|
|
404
|
+
*/
|
|
405
|
+
updateUser(userId: string, updateUserRequest: UpdateUserRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
406
|
+
};
|
|
407
|
+
/**
|
|
408
|
+
* CollaborationControllerApi - object-oriented interface
|
|
409
|
+
*/
|
|
410
|
+
export declare class CollaborationControllerApi extends BaseAPI {
|
|
411
|
+
/**
|
|
412
|
+
* Accepts a share request: creates the share and deletes the request. Accessible only by users with EDIT_SHARE role.
|
|
413
|
+
* @summary Accept a share request
|
|
414
|
+
* @param {string} id
|
|
415
|
+
* @param {*} [options] Override http request option.
|
|
416
|
+
* @throws {RequiredError}
|
|
417
|
+
*/
|
|
418
|
+
acceptShareRequest(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<number, any, {}>>;
|
|
419
|
+
/**
|
|
420
|
+
* Adds users to a team. Requires ADMIN_USERS role.
|
|
421
|
+
* @summary Add team members
|
|
422
|
+
* @param {string} teamId
|
|
423
|
+
* @param {Array<string>} requestBody
|
|
424
|
+
* @param {*} [options] Override http request option.
|
|
425
|
+
* @throws {RequiredError}
|
|
426
|
+
*/
|
|
427
|
+
addTeamMembers(teamId: string, requestBody: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
428
|
+
/**
|
|
429
|
+
* Creates new Shared document(s) with users. Returns 200 when all items are processed successfully. Returns 207 when there is a mix of successes, share requests, and/or errors. Error codes in response: - SHARE_ERR_USER_DEACTIVATED: Cannot share with a deactivated user in read-only mode - SHARE_ERR_USER_NOT_LICENSED: User must have a license to be shared with in editor or commenter mode - SHARE_ERR_PARENT_AND_CHILD: A folder and its children cannot both be in the share list - SHARE_ERR_ALREADY_EXISTS: A share already exists for this document and user
|
|
430
|
+
* @summary Create Share for document(s)
|
|
431
|
+
* @param {ShareRequest} shareRequest
|
|
432
|
+
* @param {*} [options] Override http request option.
|
|
433
|
+
* @throws {RequiredError}
|
|
434
|
+
*/
|
|
435
|
+
createSharedDocuments(shareRequest: ShareRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShareResultResponse, any, {}>>;
|
|
436
|
+
/**
|
|
437
|
+
* Creates a new team. Requires ADMIN_USERS role.
|
|
438
|
+
* @summary Create a team
|
|
439
|
+
* @param {CreateTeamRequest} createTeamRequest
|
|
440
|
+
* @param {*} [options] Override http request option.
|
|
441
|
+
* @throws {RequiredError}
|
|
442
|
+
*/
|
|
443
|
+
createTeam(createTeamRequest: CreateTeamRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
|
|
444
|
+
/**
|
|
445
|
+
* Create a new user to share documents with
|
|
446
|
+
* @summary Create a new user
|
|
447
|
+
* @param {UserRegistrationRequest} userRegistrationRequest
|
|
448
|
+
* @param {*} [options] Override http request option.
|
|
449
|
+
* @throws {RequiredError}
|
|
450
|
+
*/
|
|
451
|
+
createUser(userRegistrationRequest: UserRegistrationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
|
|
452
|
+
/**
|
|
453
|
+
* Deactivates a user. Requires ADMIN_USERS role.
|
|
454
|
+
* @summary Deactivate a user
|
|
455
|
+
* @param {string} userId
|
|
456
|
+
* @param {*} [options] Override http request option.
|
|
457
|
+
* @throws {RequiredError}
|
|
458
|
+
*/
|
|
459
|
+
deactivateUser(userId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
460
|
+
/**
|
|
461
|
+
* Deletes existing Shared document(s) with users. Returns 200 when all items are processed successfully. Returns 207 when there is a mix of successes, share requests, and/or errors. Error codes in response: - SHARE_ERR_NOT_ALREADY_SHARED: No existing share found for this document and user
|
|
462
|
+
* @summary Delete Share for document(s)
|
|
463
|
+
* @param {DeleteShareRequest} deleteShareRequest
|
|
464
|
+
* @param {*} [options] Override http request option.
|
|
465
|
+
* @throws {RequiredError}
|
|
466
|
+
*/
|
|
467
|
+
deleteSharedDocuments(deleteShareRequest: DeleteShareRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShareResultResponse, any, {}>>;
|
|
468
|
+
/**
|
|
469
|
+
* Deletes a team. Requires ADMIN_USERS role.
|
|
470
|
+
* @summary Delete a team
|
|
471
|
+
* @param {string} teamId
|
|
472
|
+
* @param {*} [options] Override http request option.
|
|
473
|
+
* @throws {RequiredError}
|
|
474
|
+
*/
|
|
475
|
+
deleteTeam(teamId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
476
|
+
/**
|
|
477
|
+
* Lists all members of a team. Requires ADMIN_USERS role.
|
|
478
|
+
* @summary Get team members
|
|
479
|
+
* @param {string} teamId
|
|
480
|
+
* @param {*} [options] Override http request option.
|
|
481
|
+
* @throws {RequiredError}
|
|
482
|
+
*/
|
|
483
|
+
getTeamMembers(teamId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TeamMemberInfo[], any, {}>>;
|
|
484
|
+
/**
|
|
485
|
+
* Confirms the current user exists in the local database. User sync happens during JWT authentication, so this endpoint simply confirms authentication was successful.
|
|
486
|
+
* @summary Check user status
|
|
487
|
+
* @param {*} [options] Override http request option.
|
|
488
|
+
* @throws {RequiredError}
|
|
489
|
+
*/
|
|
490
|
+
getUserStatus(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
491
|
+
/**
|
|
492
|
+
* Rejects and deletes a share request. Accessible only by users with EDIT_SHARE role.
|
|
493
|
+
* @summary Reject a share request
|
|
494
|
+
* @param {string} id
|
|
495
|
+
* @param {*} [options] Override http request option.
|
|
496
|
+
* @throws {RequiredError}
|
|
497
|
+
*/
|
|
498
|
+
rejectShareRequest(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
499
|
+
/**
|
|
500
|
+
* Removes users from a team. Requires ADMIN_USERS role.
|
|
501
|
+
* @summary Remove team members
|
|
502
|
+
* @param {string} teamId
|
|
503
|
+
* @param {Array<string>} requestBody
|
|
504
|
+
* @param {*} [options] Override http request option.
|
|
505
|
+
* @throws {RequiredError}
|
|
506
|
+
*/
|
|
507
|
+
removeTeamMembers(teamId: string, requestBody: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
508
|
+
/**
|
|
509
|
+
* Updates existing Shared document(s) with users. Returns 200 when all items are processed successfully. Returns 207 when there is a mix of successes, share requests, and/or errors. Error codes in response: - SHARE_ERR_USER_DEACTIVATED: Cannot share with a deactivated user in read-only mode - SHARE_ERR_USER_NOT_LICENSED: User must have a license to be shared with in editor or commenter mode - SHARE_ERR_PARENT_AND_CHILD: A folder and its children cannot both be in the share list - SHARE_ERR_NOT_ALREADY_SHARED: No existing share found for this document and user
|
|
510
|
+
* @summary Update Share for document(s)
|
|
511
|
+
* @param {ShareRequest} shareRequest
|
|
512
|
+
* @param {*} [options] Override http request option.
|
|
513
|
+
* @throws {RequiredError}
|
|
514
|
+
*/
|
|
515
|
+
updateSharedDocuments(shareRequest: ShareRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShareResultResponse, any, {}>>;
|
|
516
|
+
/**
|
|
517
|
+
* Updates team name and email. Requires ADMIN_USERS role.
|
|
518
|
+
* @summary Update a team
|
|
519
|
+
* @param {string} teamId
|
|
520
|
+
* @param {UpdateTeamRequest} updateTeamRequest
|
|
521
|
+
* @param {*} [options] Override http request option.
|
|
522
|
+
* @throws {RequiredError}
|
|
523
|
+
*/
|
|
524
|
+
updateTeam(teamId: string, updateTeamRequest: UpdateTeamRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
525
|
+
/**
|
|
526
|
+
* Updates user name, email and/or status. Requires ADMIN_USERS role. Status changes also require ASSIGN_LICENSES.
|
|
527
|
+
* @summary Update a user
|
|
528
|
+
* @param {string} userId
|
|
529
|
+
* @param {UpdateUserRequest} updateUserRequest
|
|
530
|
+
* @param {*} [options] Override http request option.
|
|
531
|
+
* @throws {RequiredError}
|
|
532
|
+
*/
|
|
533
|
+
updateUser(userId: string, updateUserRequest: UpdateUserRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
534
|
+
}
|