@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 | get3 | 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/by-kind | Propose a reorganisation by kind of document — no model involved 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 AISettingsApi | deleteSettings | DELETE /api/v1/settings/ai | Reset my AI settings AISettingsApi | getSettings | GET /api/v1/settings/ai | Get my AI settings AISettingsApi | listModels | POST /api/v1/settings/ai/models | List the provider's chat models AISettingsApi | saveSettings | PUT /api/v1/settings/ai | Save my AI settings AISettingsApi | testConnection | POST /api/v1/settings/ai/test | Test AI provider connection AuditControllerApi | auditIntegrityStatus | GET /api/v1/audit/verify/status | Last scheduled audit chain verification 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 | 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 | get2 | 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 ESignPublicApi | decline | 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 | get | 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 | list | GET /api/v1/signature-templates | List my templates ESignTemplatesApi | update | 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 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 | 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 | 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 | listUsers | GET /api/v1/admin/quotas/users | List users' storage QuotaAdministrationApi | overview | GET /api/v1/admin/quotas | Quota overview 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 SettingsApi | get1 | GET /api/v1/settings/ai/preferences | The caller's smart-filing preferences SettingsApi | getSettings1 | GET /api/v1/settings | Get user's settings SettingsApi | save | PUT /api/v1/settings/ai/preferences | Save the caller's smart-filing preferences 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") 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 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 | 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

Documentation For Models

• AiChatConversation
• AiChatRequest
• AiChatResponse
• AiConnectionTestResult
• AiModelsResponse
• AiPreferencesView
• AiSettingsResponse
• AncestorInfo
• ApplySignatureRequest
• AuditIntegrityStatusResponse
• AuditLog
• AuditLogDetails
• AuditLogDetailsOneOf
• AuditVerificationResult
• AutoFileInboxRequest
• AutoFileJobView
• AutoFileJobsRequest
• AutoFileRequest
• AutoFileTicket
• BrokenLink
• CancelInstanceRequest
• CloudSignatureSubscription
• CompleteTaskRequest
• CopyAudit
• CopyRequest
• CopyResponse
• CreateBlankDocumentRequest
• CreateFolderAudit
• CreateFolderRequest
• CreateSignatureEnvelopeRequest
• DashboardStatisticsResponse
• DeclineSignatureRequest
• DeleteAudit
• DeleteMetadataAudit
• DeleteMetadataRequest
• DeleteRequest
• DocumentInfo
• DocumentInsightView
• DocumentIntegrityRecord
• DocumentPosition
• DocumentVersionInfo
• ElementInfo
• EmbeddingBackfillRequest
• EmbeddingBackfillStatus
• ErrorResponse
• Facet
• FileTypeStats
• FilingOutcome
• FilterInput
• FolderElementInfo
• FolderResponse
• InsightBackfillRequest
• InsightBackfillStatus
• InsightCategoryUpdate
• InsightFacets
• InstantiateTemplateRequest
• Item
• ItemResult
• ListAiModelsRequest
• MergeRequest
• MergeSource
• MoveAudit
• MoveRequest
• MyStorageQuota
• MyTasksCountDTO
• OrganizeRequest
• OutputTarget
• PageInstruction
• PdfInfo
• PdfOperationResponse
• PdfOutlineEntry
• PdfOutputInfo
• PdfPageInfo
• PdfTransformAudit
• PerDefinition
• PublicSignatureView
• QuotaOverview
• QuotaUsage
• QuotaUserPage
• ReassignTaskRequest
• RenameAudit
• RenameRequest
• ReorganizationApplyRequest
• ReorganizationApplyResult
• ReorganizationByKindRequest
• ReorganizationPlanView
• ReplaceAudit
• RestoreVersionAudit
• RestoreVersionResponse
• RoleBinding
• RotateRequest
• SaveAiPreferencesRequest
• SaveAiSettingsRequest
• SaveWorkflowDefinitionRequest
• SearchByAuditLogRequest
• SearchByMetadataRequest
• SearchMetadataRequest
• Settings
• SignatureEnvelopeDTO
• SignatureEventDTO
• SignatureFieldDTO
• SignatureFieldInput
• SignatureFieldPlacement
• SignatureFieldValue
• SignatureRecipientDTO
• SignatureRecipientInput
• SignatureTemplateDTO
• SignatureTemplateField
• SignatureTemplateRequest
• SignatureTemplateRole
• SortInput
• SplitOutput
• SplitRequest
• StartWorkflowRequest
• StorageBreakdown
• Suggest
• TusConfigResponse
• TusFinalizeRequest
• TusUploadInfo
• UnzipRequest
• UnzipResponse
• UnzipSkippedEntry
• UpdateMetadataAudit
• UpdateMetadataRequest
• UploadAudit
• UploadResponse
• UserQuotaRequest
• VerifyOtpRequest
• Vote
• WorkflowAction
• WorkflowActionFailureAudit
• WorkflowAssignment
• WorkflowAudit
• WorkflowDefinitionDTO
• WorkflowEventDTO
• WorkflowInstanceDTO
• WorkflowInstanceDetailDTO
• WorkflowInstancePage
• WorkflowProblem
• WorkflowReview
• WorkflowReviewProgressDTO
• WorkflowSpec
• WorkflowState
• WorkflowSummaryDTO
• WorkflowTaskDTO
• WorkflowTransition
• WorkflowValidationResult

Documentation For Authorization

Authentication schemes defined for the API:

keycloak_auth

• Type: Bearer authentication (JWT)