@openfilz-sdk/[email protected]

This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:

Environment

• Node.js
• Webpack
• Browserify

Language level

• ES5 - you must have a Promises/A+ library installed
• ES6

Module system

• CommonJS
• ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)

Building

To build and compile the typescript sources to javascript use:

npm install
npm run build

Publishing

First build the package then run npm publish

Consuming

navigate to the folder of your consuming project and run one of the following commands.

published:

npm install @openfilz-sdk/[email protected] --save

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save

Documentation for API Endpoints

All URIs are relative to http://localhost:8081

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- AuditControllerApi | getAuditTrail | GET /api/v1/audit/{id} | Get audit trail for a resource AuditControllerApi | searchAuditTrail | POST /api/v1/audit/search | Search for audit trails AuditControllerApi | verifyChain | GET /api/v1/audit/verify | Verify audit chain integrity DashboardApi | getDashboardStatistics | GET /api/v1/dashboard/statistics | Get dashboard statistics DocumentControllerApi | createBlankDocument | POST /api/v1/documents/create-blank | Create a blank document from template DocumentControllerApi | deleteDocumentMetadata | DELETE /api/v1/documents/{documentId}/metadata | Delete specific metadata keys DocumentControllerApi | downloadDocument | GET /api/v1/documents/{documentId}/download | Download a document DocumentControllerApi | downloadForOnlyOffice | GET /api/v1/documents/{documentId}/onlyoffice-download | Download document for OnlyOffice DocumentControllerApi | downloadMultipleDocumentsAsZip | POST /api/v1/documents/download-multiple | Download multiple documents as ZIP DocumentControllerApi | getDocumentAncestors | GET /api/v1/documents/{documentId}/ancestors | Get document ancestors DocumentControllerApi | getDocumentInfo | GET /api/v1/documents/{documentId}/info | Get information of a document DocumentControllerApi | getDocumentMetadata | POST /api/v1/documents/{documentId}/search/metadata | Search metadata of a document DocumentControllerApi | getDocumentPosition | GET /api/v1/documents/{documentId}/position | Get document position in folder DocumentControllerApi | replaceDocumentContent | PUT /api/v1/documents/{documentId}/replace-content | Replace document content DocumentControllerApi | replaceDocumentMetadata | PUT /api/v1/documents/{documentId}/replace-metadata | Replace document metadata DocumentControllerApi | searchDocumentIdsByMetadata | POST /api/v1/documents/search/ids-by-metadata | Search document IDs by metadata DocumentControllerApi | updateDocumentMetadata | PATCH /api/v1/documents/{documentId}/metadata | Update document metadata DocumentControllerApi | uploadDocument | POST /api/v1/documents/upload-multiple | Upload multiple documents DocumentControllerApi | uploadDocument1 | POST /api/v1/documents/upload | Upload a single document DocumentSuggestionControllerApi | getSuggestions | GET /api/v1/suggestions | FavoritesApi | addFavorite | POST /api/v1/favorites/{documentId} | Add document to favorites FavoritesApi | isFavorite | GET /api/v1/favorites/{documentId}/is-favorite | Check favorite status FavoritesApi | removeFavorite | DELETE /api/v1/favorites/{documentId} | Remove document from favorites FavoritesApi | toggleFavorite | PUT /api/v1/favorites/{documentId}/toggle | Toggle favorite status FileControllerApi | copyFiles | POST /api/v1/files/copy | Copy files FileControllerApi | deleteFiles | DELETE /api/v1/files | Delete files FileControllerApi | moveFiles | POST /api/v1/files/move | Move files FileControllerApi | renameFile | PUT /api/v1/files/{fileId}/rename | Rename a file FolderControllerApi | copyFolders | POST /api/v1/folders/copy | Copy folders FolderControllerApi | countFolderElements | GET /api/v1/folders/count | Count files and subfolders contained in a given folder - return 0 if empty or not exists FolderControllerApi | createFolder | POST /api/v1/folders | Create a new folder FolderControllerApi | deleteFolders | DELETE /api/v1/folders | Delete folders FolderControllerApi | listFolder | GET /api/v1/folders/list | List files and subfolders contained in a given folder FolderControllerApi | moveFolders | POST /api/v1/folders/move | Move folders FolderControllerApi | renameFolder | PUT /api/v1/folders/{folderId}/rename | Rename a folder SettingsApi | getSettings | GET /api/v1/settings | Get user's settings TusControllerApi | _options | OPTIONS /api/v1/tus | TUS capability discovery TusControllerApi | cancelUpload | DELETE /api/v1/tus/{uploadId} | Cancel upload TusControllerApi | createUpload | POST /api/v1/tus | Create new TUS upload TusControllerApi | finalizeUpload | POST /api/v1/tus/{uploadId}/finalize | Finalize upload TusControllerApi | getConfig | GET /api/v1/tus/config | Get TUS configuration TusControllerApi | getUploadInfo | GET /api/v1/tus/{uploadId}/info | Get upload information TusControllerApi | getUploadOffset | HEAD /api/v1/tus/{uploadId} | Get upload progress TusControllerApi | isUploadComplete | GET /api/v1/tus/{uploadId}/complete | Check upload completion TusControllerApi | uploadChunk | PATCH /api/v1/tus/{uploadId} | Upload chunk

Documentation For Models

• AncestorInfo
• AuditLog
• AuditLogDetails
• AuditLogDetailsOneOf
• AuditVerificationResult
• BrokenLink
• CopyAudit
• CopyRequest
• CopyResponse
• CreateBlankDocumentRequest
• CreateFolderAudit
• CreateFolderRequest
• DashboardStatisticsResponse
• DeleteAudit
• DeleteMetadataAudit
• DeleteMetadataRequest
• DeleteRequest
• DocumentInfo
• DocumentPosition
• ElementInfo
• FileTypeStats
• FilterInput
• FolderElementInfo
• FolderResponse
• MoveAudit
• MoveRequest
• RenameAudit
• RenameRequest
• ReplaceAudit
• SearchByAuditLogRequest
• SearchByMetadataRequest
• SearchMetadataRequest
• Settings
• SortInput
• StorageBreakdown
• Suggest
• TusConfigResponse
• TusFinalizeRequest
• TusUploadInfo
• UpdateMetadataAudit
• UpdateMetadataRequest
• UploadAudit
• UploadResponse

Documentation For Authorization

Authentication schemes defined for the API:

keycloak_auth

• Type: Bearer authentication (JWT)