@openfilz-sdk/typescript-ee

v1.13.2

Published

a day ago

OpenAPI client for @openfilz-sdk/typescript-ee

Downloads

5,808

0High
0Medium
0Low

openfilz

axios typescript openapi-client openapi-generator @openfilz-sdk/typescript-ee

@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 ------------ | ------------- | ------------- | ------------- AIChatApi | apply | POST /api/v1/ai/reorganization/{planId}/apply | Apply a proposed reorganisation plan AIChatApi | chat | POST /api/v1/ai/chat | Chat with AI assistant AIChatApi | deleteConversation | DELETE /api/v1/ai/conversations/{conversationId} | Delete conversation AIChatApi | discard | POST /api/v1/ai/reorganization/{planId}/discard | Discard a proposed reorganisation plan AIChatApi | get9 | GET /api/v1/ai/reorganization/{planId} | Get a reorganisation plan proposed by the AI assistant AIChatApi | getConversationHistory | GET /api/v1/ai/conversations/{conversationId} | Get conversation history AIChatApi | listConversations | GET /api/v1/ai/conversations | List conversations AIChatApi | proposeByKind | POST /api/v1/ai/reorganization/folders/by-kind | Organise several folders by kind of document as one plan — no model involved AIChatApi | proposeByKind1 | POST /api/v1/ai/reorganization/by-kind | Propose a reorganisation by kind of document — no model involved AIDirectoryApi | teams | GET /api/v1/admin/ai/directory/teams | The teams of the DMS database (the ids the AI features store) AIEmbeddingsApi | backfill1 | POST /api/v1/ai/embeddings/backfill | Embed existing documents AIEmbeddingsApi | backfillStatus1 | GET /api/v1/ai/embeddings/backfill/{jobId} | Progress of an embedding backfill job AIFilingRulesApi | create3 | POST /api/v1/admin/ai/filing-rules | Create a filing rule AIFilingRulesApi | delete2 | DELETE /api/v1/admin/ai/filing-rules/{id} | Delete a filing rule (its events go with it) AIFilingRulesApi | events1 | GET /api/v1/admin/ai/filing-rules/{id}/events | What the rule did lately (MATCHED / DRY_RUN / SKIPPED), newest first AIFilingRulesApi | get6 | GET /api/v1/admin/ai/filing-rules/{id} | One filing rule AIFilingRulesApi | list4 | GET /api/v1/admin/ai/filing-rules | List the filing rules, by priority AIFilingRulesApi | test | POST /api/v1/admin/ai/filing-rules/{id}/test | Dry evaluation of the rule against an existing document AIFilingRulesApi | update4 | PUT /api/v1/admin/ai/filing-rules/{id} | Replace a filing rule AIGovernanceApi | get5 | GET /api/v1/admin/ai/governance | The AI governance settings in force AIGovernanceApi | put1 | PUT /api/v1/admin/ai/governance | Replace the AI governance settings AIMaintenanceApi | jobs1 | GET /api/v1/admin/ai/maintenance/jobs | AIMaintenanceApi | overview1 | GET /api/v1/admin/ai/maintenance | What can run here, and the recent library-wide jobs of this instance AIMaintenanceApi | start2 | POST /api/v1/admin/ai/maintenance/{kind} | Start a library-wide job: embeddings (re-embed) or insights (re-enrich). force=true redoes documents that are already up to date AIMaintenanceApi | status2 | GET /api/v1/admin/ai/maintenance/jobs/{jobId} | Progress of a library-wide job (sum of its per-owner jobs) AISettingsApi | deleteSettings | DELETE /api/v1/settings/ai | Reset my AI settings AISettingsApi | getSettings1 | GET /api/v1/settings/ai | Get my AI settings AISettingsApi | listModels | POST /api/v1/settings/ai/models | List the provider's chat models AISettingsApi | saveSettings1 | PUT /api/v1/settings/ai | Save my AI settings AISettingsApi | testConnection | POST /api/v1/settings/ai/test | Test AI provider connection AITaxonomyApi | get4 | GET /api/v1/admin/ai/taxonomy | The taxonomy and where it comes from AITaxonomyApi | put | PUT /api/v1/admin/ai/taxonomy | Replace the whole taxonomy AITaxonomyApi | rename | POST /api/v1/admin/ai/taxonomy/{key}/rename | Rename a kind AITaxonomyApi | reset | POST /api/v1/admin/ai/taxonomy/reset | Delete every managed kind: the properties list rules again AITeamInboxesApi | create2 | POST /api/v1/admin/ai/team-inboxes | Create a team inbox AITeamInboxesApi | delete1 | DELETE /api/v1/admin/ai/team-inboxes/{id} | Delete a team inbox (the folder and its documents stay) AITeamInboxesApi | get3 | GET /api/v1/admin/ai/team-inboxes/{id} | One team inbox, with its warnings AITeamInboxesApi | list3 | GET /api/v1/admin/ai/team-inboxes | List the team inboxes AITeamInboxesApi | run | POST /api/v1/admin/ai/team-inboxes/{id}/run | File the inbox now AITeamInboxesApi | update3 | PUT /api/v1/admin/ai/team-inboxes/{id} | Replace a team inbox AiAnalyticsAdminControllerApi | analytics | GET /api/v1/admin/ai/analytics | Tenant-wide AI insights and smart-filing analytics (admin only) AiArchivingAdminControllerApi | create4 | POST /api/v1/admin/ai/archiving/schedules | Create an archiving schedule AiArchivingAdminControllerApi | delete3 | DELETE /api/v1/admin/ai/archiving/schedules/{id} | Delete an archiving schedule AiArchivingAdminControllerApi | get7 | GET /api/v1/admin/ai/archiving/schedules/{id} | Get an archiving schedule AiArchivingAdminControllerApi | propose | POST /api/v1/admin/ai/archiving/propose | Propose an archiving plan now (admin only) AiArchivingAdminControllerApi | run1 | POST /api/v1/admin/ai/archiving/schedules/{id}/run | Run an archiving schedule now AiArchivingAdminControllerApi | schedules | GET /api/v1/admin/ai/archiving/schedules | List archiving schedules AiArchivingAdminControllerApi | update5 | PUT /api/v1/admin/ai/archiving/schedules/{id} | Update an archiving schedule AiCloudUsageAdminControllerApi | cloudUsage | GET /api/v1/admin/ai/cloud-usage | OpenFilz Cloud AI usage of this deployment for the current month (admin only) ArchiveControllerApi | archive | POST /api/v1/archive/documents/{documentId} | Archive a document ArchiveControllerApi | archiveFolder | POST /api/v1/archive/folders/{folderId} | Archive the caller's own files in a folder subtree ArchiveControllerApi | preflight | GET /api/v1/archive/preflight/{documentId} | What archiving this would actually do ArchiveControllerApi | reassignOwner | PUT /api/v1/archive/documents/{documentId}/owner | Hand custody of an archived document to another user ArchiveControllerApi | restore | POST /api/v1/archive/documents/{archiveDocumentId}/restore | Restore an archived document into this instance CollaborationAuditControllerApi | auditIntegrityStatus | GET /api/v1/audit/verify/status | Last scheduled audit chain verification 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 DesktopSyncApi | changes | GET /api/v1/sync/changes | Documents that changed since a cursor, as the caller sees them now DesktopSyncApi | content | GET /api/v1/sync/content/{documentId} | Download a file; its ETag is the SHA-256 of the content DesktopSyncApi | discover | GET /.well-known/openfilz-desktop | Connection details for the desktop application (public) DesktopSyncApi | forWebApplication | GET /api/v1/settings/desktop-sync | Where to get the desktop application, and the address to give it DesktopSyncApi | items | GET /api/v1/sync/items | Current state of the given documents, as the caller sees them DesktopSyncApi | replaceContent | PUT /api/v1/sync/content/{documentId} | Replace a file's content, only if it is still the content the edit was based on DesktopSyncApi | snapshot | GET /api/v1/sync/snapshot | One page of a folder's children; without folderId, the caller's root DesktopSyncAdministrationApi | start1 | POST /api/v1/admin/sync/backfill | Run the backfill again over every file DesktopSyncAdministrationApi | status | GET /api/v1/admin/sync/backfill | Progress of the size and hash backfill 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 | getDocumentIntegrity | GET /api/v1/documents/{documentId}/integrity | Get a document's integrity ledger 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 DocumentInsightsApi | backfill | POST /api/v1/ai/insights/backfill | Enrich existing documents DocumentInsightsApi | backfillStatus | GET /api/v1/ai/insights/backfill/{jobId} | Progress of a backfill job DocumentInsightsApi | facets | GET /api/v1/ai/insights/facets | The category and language facets of the library DocumentInsightsApi | getInsights | GET /api/v1/documents/{documentId}/insights | Get the insights of a document DocumentInsightsApi | setCategory | PATCH /api/v1/documents/{documentId}/insights | Correct the kind of a 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 ESignApi | cancel1 | POST /api/v1/signatures/{id}/cancel | Cancel a non-terminal envelope ESignApi | cloudSubscription | GET /api/v1/signatures/cloud-subscription | Cloud Signing subscription and month-to-date usage (openfilz-cloud seal provider only) ESignApi | create | POST /api/v1/signatures | Create an envelope (sent immediately unless send=false) ESignApi | events | GET /api/v1/signatures/{id}/events | Audit trail of one of my envelopes ESignApi | get8 | GET /api/v1/signatures/{id} | Get one of my envelopes (recipients + fields) ESignApi | listSent | GET /api/v1/signatures | List envelopes I sent for signature ESignApi | listToSign | GET /api/v1/signatures/to-sign | List envelopes waiting for my signature ESignApi | resend | POST /api/v1/signatures/{id}/recipients/{recipientId}/resend | Resend the signing link to a recipient (new token, previous one revoked) ESignApi | send | POST /api/v1/signatures/{id}/send | Send a DRAFT envelope ESignApi | signedDocument | GET /api/v1/signatures/{id}/signed-document | Download the sealed PDF of a completed envelope ESignEnterpriseApi | archive1 | GET /api/v1/signatures/{id}/archive | PDF/A-2b archive + veraPDF compliance for a completed envelope ESignEnterpriseApi | bulk | POST /api/v1/signatures/bulk | Create (and send) one envelope per row from a template ESignEnterpriseApi | embedUrl | POST /api/v1/signatures/{id}/recipients/{recipientId}/embed-url | Mint an embedded-signing URL for a recipient (rotates the token; no email is sent) ESignPublicApi | decline1 | POST /api/v1/public/signatures/decline | Decline to sign (voids the envelope) ESignPublicApi | document | GET /api/v1/public/signatures/document | Stream the source PDF for signing ESignPublicApi | markViewed | POST /api/v1/public/signatures/viewed | Record that the recipient opened the document ESignPublicApi | requestOtp | POST /api/v1/public/signatures/otp/request | Send a one-time access code to the recipient (EMAIL_OTP / SMS_OTP) ESignPublicApi | sign | POST /api/v1/public/signatures/sign | Submit the recipient's fields and sign ESignPublicApi | verifyOtp | POST /api/v1/public/signatures/otp/verify | Verify the one-time access code ESignPublicApi | view | GET /api/v1/public/signatures | Resolve a signing token to its envelope view ESignTemplatesApi | _delete | DELETE /api/v1/signature-templates/{id} | Delete a template ESignTemplatesApi | create1 | POST /api/v1/signature-templates | Create a template ESignTemplatesApi | get1 | GET /api/v1/signature-templates/{id} | Get a template ESignTemplatesApi | instantiate | POST /api/v1/signature-templates/{id}/envelopes | Create (and send) an envelope from a template ESignTemplatesApi | list1 | GET /api/v1/signature-templates | List my templates ESignTemplatesApi | update1 | PUT /api/v1/signature-templates/{id} | Update a template 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 FeatureEntitlementsApi | getFeatureEntitlements | GET /api/v1/admin/features | Deployment + licence state per optional feature 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 FileControllerApi | unzipFile | POST /api/v1/files/{fileId}/unzip | Extract a ZIP 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 McpDiscoveryControllerApi | authorizationServerMetadata | GET /.well-known/oauth-authorization-server | McpDiscoveryControllerApi | protectedResourceMetadata | GET /.well-known/oauth-protected-resource | McpTokenAdminControllerApi | config | GET /api/v1/admin/mcp/tokens/config | Whether agent tokens can be minted here, and the TTL bounds (no secrets) McpTokenAdminControllerApi | list2 | GET /api/v1/admin/mcp/tokens | List minted MCP agent tokens (never returns the credentials) McpTokenAdminControllerApi | mint | POST /api/v1/admin/mcp/tokens | Mint an MCP agent token for a dedicated user (admin only) McpTokenAdminControllerApi | revoke1 | DELETE /api/v1/admin/mcp/tokens/{jti} | Revoke an MCP agent token 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 OrganisationSettingsApi | list | GET /api/v1/admin/settings | List the organisation settings with their effective and deployment values OrganisationSettingsApi | reset1 | DELETE /api/v1/admin/settings/{key} | Reset a setting to its deployment value OrganisationSettingsApi | update2 | PUT /api/v1/admin/settings | Change settings (map of key → value). All are validated before any is stored; a locked key answers 409, an unknown key or invalid value 400 OwnershipApi | adminCountOwnedDocuments | GET /api/v1/admin/ownership/users/{userId}/documents/count | Count the documents a user owns (same filter as the listing) OwnershipApi | adminGetOwnershipEligibility | GET /api/v1/admin/ownership/users/{userId}/eligibility | May the caller act on this user's documents now? OwnershipApi | adminGetOwnershipTransfer | GET /api/v1/admin/ownership/transfers/{jobId} | A transfer's progress and outcome OwnershipApi | adminListOwnedDocuments | GET /api/v1/admin/ownership/users/{userId}/documents | List the documents a user owns OwnershipApi | adminListOwnershipTransfers | GET /api/v1/admin/ownership/transfers | The last 50 transfers from or to a user OwnershipApi | adminRequestOwnershipConsent | POST /api/v1/admin/ownership/users/{userId}/consent | Ask the user for their consent to transfer their documents OwnershipApi | adminTransferOwnership | POST /api/v1/admin/ownership/transfers | Transfer documents to another user OwnershipApi | countOwnedDocuments | GET /api/v1/users/ownership/users/{userId}/documents/count | Count the documents a user owns (same filter as the listing) OwnershipApi | getOwnershipEligibility | GET /api/v1/users/ownership/users/{userId}/eligibility | May the caller act on this user's documents now? OwnershipApi | getOwnershipTransfer | GET /api/v1/users/ownership/transfers/{jobId} | A transfer's progress and outcome OwnershipApi | listOwnedDocuments | GET /api/v1/users/ownership/users/{userId}/documents | List the documents a user owns OwnershipApi | listOwnershipTransfers | GET /api/v1/users/ownership/transfers | The last 50 transfers from or to a user OwnershipApi | requestOwnershipConsent | POST /api/v1/users/ownership/users/{userId}/consent | Ask the user for their consent to transfer their documents OwnershipApi | transferOwnership | POST /api/v1/users/ownership/transfers | Transfer documents to another user PDFToolsApi | info | GET /api/v1/pdf/{documentId}/info | Describe a stored PDF PDFToolsApi | merge | POST /api/v1/pdf/merge | Merge PDFs PDFToolsApi | organize | POST /api/v1/pdf/organize | Reorganise the pages of a PDF PDFToolsApi | rotate | POST /api/v1/pdf/rotate | Rotate pages PDFToolsApi | split | POST /api/v1/pdf/split | Split a PDF QuotaAdministrationApi | clear | DELETE /api/v1/admin/quotas/teams/{teamId} | Remove a team's limit QuotaAdministrationApi | clearUserQuota | DELETE /api/v1/admin/quotas/users/{username} | Remove one user's own limit QuotaAdministrationApi | getUser | GET /api/v1/admin/quotas/users/{username} | Get one user's storage QuotaAdministrationApi | list5 | GET /api/v1/admin/quotas/teams | List teams with their per-member limit and their members' usage QuotaAdministrationApi | listUsers | GET /api/v1/admin/quotas/users | List users' storage QuotaAdministrationApi | overview | GET /api/v1/admin/quotas | Quota overview QuotaAdministrationApi | set | PUT /api/v1/admin/quotas/teams/{teamId} | Set a team's per-member limit QuotaAdministrationApi | setUserQuota | PUT /api/v1/admin/quotas/users/{username} | Set one user's own limit QuotasApi | myQuota | GET /api/v1/quotas/me | Get my storage quota 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 | refreshMetadata | POST /api/v1/admin/search/refresh-metadata | Refresh index metadata SearchAdministrationApi | reindexAll | POST /api/v1/admin/search/reindex | Reindex all documents SettingsApi | get2 | GET /api/v1/settings/ai/preferences | The caller's smart-filing preferences SettingsApi | getLicenseInfo | GET /api/v1/settings/license | Coarse license info SettingsApi | getSettings | GET /api/v1/settings | Get user's settings SettingsApi | save | PUT /api/v1/settings/ai/preferences | Save the caller's smart-filing preferences SettingsApi | saveSettings | PUT /api/v1/settings | Save user preferences SharingApi | getShareInheritance | GET /api/v1/documents/{id}/share-inheritance | Does the document receive the shares of its ancestors? SharingApi | setShareInheritance | PUT /api/v1/users/share/inheritance/{id} | Stop (inherit=false) or resume (inherit=true) inheriting the ancestors' shares SmartFilingApi | file | POST /api/v1/ai/auto-file | File existing documents on demand SmartFilingApi | fileInbox | POST /api/v1/ai/auto-file/inbox | File everything lying loose in the caller's Inbox SmartFilingApi | job | GET /api/v1/ai/auto-file/{jobId} | Progress and outcome of a filing job SmartFilingApi | jobs | POST /api/v1/ai/auto-file/jobs | Progress and outcome of several filing jobs SmartFilingApi | lastFiling | GET /api/v1/ai/auto-file/document/{documentId} | The latest filing record of a document (the "Filed by OpenFilz" chip) SmartFilingApi | undo | POST /api/v1/ai/auto-file/{jobId}/undo | Move every document the job filed back where it came from SmartFilingApi | undoFiling | POST /api/v1/ai/auto-file/filing/{planId}/undo | Move one filed document back (the chip's "Move back") StorageEncryptionAdministrationApi | attest | POST /api/v1/admin/storage/encryption/attest | Prove the customer's KEK is usable right now StorageEncryptionAdministrationApi | reencrypt | POST /api/v1/admin/storage/encryption/reencrypt | Run the re-encryption pass in the background StorageEncryptionAdministrationApi | rewrap | POST /api/v1/admin/storage/encryption/rewrap | Re-wrap every master key under the provider's current KEK StorageEncryptionAdministrationApi | rotateMasterKey | POST /api/v1/admin/storage/encryption/rotate-master-key | Create a new active master key StorageEncryptionAdministrationApi | status1 | GET /api/v1/admin/storage/encryption/status | Configuration, master key ring state and re-encryption pass progress 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/** | WorkflowsApi | cancel | POST /api/v1/workflows/instances/{id}/cancel | Cancel a running instance (initiator) WorkflowsApi | complete | POST /api/v1/workflows/tasks/{id}/complete | Take a transition on a task I am a candidate of WorkflowsApi | createDefinition | POST /api/v1/workflows/definitions | Create a workflow definition (400 with the problem list when invalid) WorkflowsApi | deleteDefinition | DELETE /api/v1/workflows/definitions/{id} | Delete a workflow definition (409 while instances are running) WorkflowsApi | getDefinition | GET /api/v1/workflows/definitions/{id} | Get a workflow definition WorkflowsApi | getInstance | GET /api/v1/workflows/instances/{id} | One instance with its snapshot spec, open task and history WorkflowsApi | listDefinitions | GET /api/v1/workflows/definitions | List the workflow definitions the caller may see (mine = created by the caller) WorkflowsApi | listInstances | GET /api/v1/workflows/instances | List instances (monitor), newest first WorkflowsApi | myTasks | GET /api/v1/workflows/tasks/mine | Open tasks I can act on (by e-mail or role) WorkflowsApi | myTasksCount | GET /api/v1/workflows/tasks/mine/count | Number of open tasks I can act on (sidebar badge) WorkflowsApi | reassign | POST /api/v1/workflows/tasks/{id}/reassign | Hand a task to other people (initiator or current candidate) WorkflowsApi | start | POST /api/v1/workflows/instances | Start a workflow on a document (409 when one is already running) WorkflowsApi | summary | GET /api/v1/workflows/instances/summary | Counts for the monitor header WorkflowsApi | teamDefinitions | GET /api/v1/workflows/team-definitions | Workflow definitions authored by the caller's teammates WorkflowsApi | updateDefinition | PUT /api/v1/workflows/definitions/{id} | Update a workflow definition (running instances keep their snapshot) WorkflowsApi | validateDefinition | POST /api/v1/workflows/definitions/validate | Validate a definition without saving it

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

@openfilz-sdk/[email protected]

Building

Publishing

Consuming

Documentation for API Endpoints

Documentation For Models

Documentation For Authorization

keycloak_auth