@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 ------------ | ------------- | ------------- | ------------- CollaborationAuditControllerApi | getAuditTrail | GET /api/v1/audit/{id} | Get audit trail for a resource (enriched with actor azp) CollaborationAuditControllerApi | searchAuditTrail | POST /api/v1/audit/search | Search audit trail (enriched with actor azp) CollaborationAuditControllerApi | verifyChain | GET /api/v1/audit/verify | Verify audit chain integrity CollaborationControllerApi | acceptShareRequest | POST /api/v1/users/share-requests/{id}/accept | Accept a share request CollaborationControllerApi | addTeamMembers | POST /api/v1/users/teams/{teamId}/members | Add team members CollaborationControllerApi | createSharedDocuments | POST /api/v1/users/share | Create Share for document(s) CollaborationControllerApi | createTeam | POST /api/v1/users/teams | Create a team CollaborationControllerApi | createUser | POST /api/v1/users | Create a new user CollaborationControllerApi | deactivateUser | DELETE /api/v1/users/{userId} | Deactivate a user CollaborationControllerApi | deleteSharedDocuments | DELETE /api/v1/users/share | Delete Share for document(s) CollaborationControllerApi | deleteTeam | DELETE /api/v1/users/teams/{teamId} | Delete a team CollaborationControllerApi | getTeamMembers | GET /api/v1/users/teams/{teamId}/members | Get team members CollaborationControllerApi | getUserStatus | GET /api/v1/users/me/status | Check user status CollaborationControllerApi | rejectShareRequest | DELETE /api/v1/users/share-requests/{id} | Reject a share request CollaborationControllerApi | removeTeamMembers | DELETE /api/v1/users/teams/{teamId}/members | Remove team members CollaborationControllerApi | updateSharedDocuments | PUT /api/v1/users/share | Update Share for document(s) CollaborationControllerApi | updateTeam | PUT /api/v1/users/teams/{teamId} | Update a team CollaborationControllerApi | updateUser | PUT /api/v1/users/{userId} | Update a user CommentsApi | createComment | POST /api/v1/documents/comments | Create a comment CommentsApi | deleteComment | DELETE /api/v1/documents/comments/{id} | Delete a comment CommentsApi | updateComment | PUT /api/v1/documents/comments/{id} | Update a comment DashboardApi | getDashboardStatistics | GET /api/v1/dashboard/statistics | Get dashboard statistics DelegatedBrowseGrantsAdminApi | browseFolders | GET /api/v1/admin/delegated/folders | Browse folders on behalf of the grantor DelegatedBrowseGrantsAdminApi | consume | POST /api/v1/admin/delegated/grants/{id}/consume | Mark grant as consumed DelegatedBrowseGrantsAdminApi | getGrant | GET /api/v1/admin/delegated/grants/{id} | Poll grant status DelegatedBrowseGrantsAdminApi | listMine | GET /api/v1/admin/delegated/grants | List grants I requested DelegatedBrowseGrantsAdminApi | requestGrant | POST /api/v1/admin/delegated/grants | Request a grant DelegatedBrowseGrantsEndUserApi | accept | POST /api/v1/users/me/delegated/grants/{id}/accept | Approve a pending grant DelegatedBrowseGrantsEndUserApi | decline | POST /api/v1/users/me/delegated/grants/{id}/decline | Refuse a pending grant DelegatedBrowseGrantsEndUserApi | disableLinkedWebhook | POST /api/v1/users/me/delegated/grants/{id}/disable-webhook | Disable the webhook created from this grant DelegatedBrowseGrantsEndUserApi | listIncoming | GET /api/v1/users/me/delegated/grants | List grants addressed to me DelegatedBrowseGrantsEndUserApi | revoke | POST /api/v1/users/me/delegated/grants/{id}/revoke | Revoke an accepted grant DigitalSignatureApi | archive | GET /api/v1/signatures/{id}/archive | Get the PDF/A archive + veraPDF compliance for a completed envelope DigitalSignatureApi | cancel | POST /api/v1/signatures/{id}/cancel | Cancel a non-terminal envelope DigitalSignatureApi | create | POST /api/v1/signatures | Create and send a signature envelope DigitalSignatureApi | get1 | GET /api/v1/signatures/{id} | Get a single envelope I sent DigitalSignatureApi | listSent | GET /api/v1/signatures | List envelopes I sent for signature DigitalSignatureApi | listToSign | GET /api/v1/signatures/to-sign | List documents waiting for my signature DigitalSignaturePublicApi | decline1 | POST /api/v1/public/signatures/decline | Decline to sign (voids the envelope) DigitalSignaturePublicApi | document | GET /api/v1/public/signatures/document | Stream the source PDF for signing DigitalSignaturePublicApi | markViewed | POST /api/v1/public/signatures/viewed | Record that the recipient opened the document DigitalSignaturePublicApi | sign | POST /api/v1/public/signatures/sign | Apply the recipient's signature DigitalSignaturePublicApi | view | GET /api/v1/public/signatures | Resolve a signing token to its envelope view 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 | DocumentVersionControllerApi | downloadVersion | GET /api/v1/documents/{documentId}/versions/{versionId}/download | Download a specific document version DocumentVersionControllerApi | listVersions | GET /api/v1/documents/{documentId}/versions | List document versions DocumentVersionControllerApi | restoreVersion | POST /api/v1/documents/{documentId}/versions/{versionId}/restore | Restore a previous document version 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 NotificationsApi | getNotifications | GET /api/v1/notifications | Get all notifications NotificationsApi | getUnreadCount | GET /api/v1/notifications/unread/count | Get unread notification count NotificationsApi | markAllAsRead | PUT /api/v1/notifications/read-all | Mark all notifications as read NotificationsApi | markAsRead | PUT /api/v1/notifications/{id}/read | Mark notification as read NotificationsApi | streamNotifications | GET /api/v1/notifications/stream | Subscribe to notification stream ScanAgentApi | download | GET /api/v1/agent/download/{platform} | Download agent binary ScanAgentApi | getVersion | GET /api/v1/agent/version | Get agent version ScannerProxyApi | getIngestionStatus | GET /api/v1/scan/status | Get ingestion status ScannerProxyApi | getScanJobStatus | GET /api/v1/scan/scanners/{id}/scan/{jobId}/status | Get scan job status ScannerProxyApi | getScannerCapabilities | GET /api/v1/scan/scanners/{id}/capabilities | Get scanner capabilities ScannerProxyApi | listScanners | GET /api/v1/scan/scanners | List scanners ScannerProxyApi | triggerScan | POST /api/v1/scan/scanners/{id}/scan | Trigger scan SearchAdministrationApi | createIndex | POST /api/v1/admin/search | Create search index SearchAdministrationApi | deleteIndex | DELETE /api/v1/admin/search | Delete search index SearchAdministrationApi | getStatus | GET /api/v1/admin/search/status | Get reindexation status SearchAdministrationApi | reindexAll | POST /api/v1/admin/search/reindex | Reindex all documents SettingsApi | getSettings | GET /api/v1/settings | Get user's settings SettingsApi | saveSettings | PUT /api/v1/settings | Save user preferences 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 UploadTokenControllerApi | mintUploadToken | POST /api/v1/upload-tokens | Mint a scoped upload token UploadTokenControllerApi | uploadWithToken | POST /api/v1/upload-tokens/upload | Upload a single document with a scoped upload token UserPrivacyApi | get | GET /api/v1/users/me/privacy | Read my privacy preferences UserPrivacyApi | update | PUT /api/v1/users/me/privacy | Update my privacy preferences WebhookProxyControllerApi | proxy | GET /api/v1/webhooks/** | WebhookProxyControllerApi | proxy1 | POST /api/v1/webhooks/** | WebhookProxyControllerApi | proxy2 | PUT /api/v1/webhooks/** | WebhookProxyControllerApi | proxy3 | DELETE /api/v1/webhooks/** | WebhookProxyControllerApi | proxy4 | PATCH /api/v1/webhooks/** | WebhookProxyControllerApi | proxy5 | HEAD /api/v1/webhooks/** | WebhookProxyControllerApi | proxy6 | OPTIONS /api/v1/webhooks/** |

Documentation For Models

• AncestorInfo
• ApplySignatureRequest
• AuditLogDetails
• AuditVerificationResult
• BrokenLink
• CommentDTO
• ConsumeDelegatedGrantRequest
• CopyAudit
• CopyRequest
• CopyResponse
• CreateBlankDocumentRequest
• CreateCommentRequest
• CreateDelegatedGrantRequest
• CreateFolderAudit
• CreateFolderRequest
• CreateSignatureEnvelopeRequest
• CreateTeamRequest
• DashboardStatisticsResponse
• DeclineSignatureRequest
• DelegatedFolderNode
• DelegatedGrantDTO
• DeleteAudit
• DeleteMetadataAudit
• DeleteMetadataRequest
• DeleteRequest
• DeleteShareRequest
• DocumentInfo
• DocumentPosition
• DocumentVersionInfo
• ElementInfo
• EnrichedAuditLog
• EnrichedAuditLogDetails
• FileTypeStats
• FilterInput
• FolderElementInfo
• FolderResponse
• IngestionStatusDto
• MintUploadTokenRequest
• MoveAudit
• MoveRequest
• NotificationDTO
• PublicSignatureView
• RenameAudit
• RenameRequest
• ReplaceAudit
• RestoreVersionAudit
• RestoreVersionResponse
• ScanJobStatusDto
• ScanRequestDto
• ScannerInfoDto
• SearchByAuditLogRequest
• SearchByMetadataRequest
• SearchMetadataRequest
• Settings
• ShareRequest
• ShareResultError
• ShareResultItem
• ShareResultResponse
• SignatureArchiveDTO
• SignatureEnvelopeDTO
• SignatureFieldPlacement
• SignatureRecipientDTO
• SignatureRecipientInput
• SortInput
• StorageBreakdown
• Suggest
• TeamMemberInfo
• TusConfigResponse
• TusFinalizeRequest
• TusUploadInfo
• UpdateCommentRequest
• UpdateMetadataAudit
• UpdateMetadataRequest
• UpdateTeamRequest
• UpdateUserPrivacyRequest
• UpdateUserRequest
• UploadAudit
• UploadResponse
• UploadTokenResponse
• UserPreferencesRequest
• UserPrivacyDTO
• UserRegistrationRequest

Documentation For Authorization

Authentication schemes defined for the API:

keycloak_auth

• Type: Bearer authentication (JWT)