## @openfilz-sdk/typescript@1.3.52 This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/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](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) ### 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/typescript@1.3.52 --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**](docs/AIChatApi.md#apply) | **POST** /api/v1/ai/reorganization/{planId}/apply | Apply a proposed reorganisation plan *AIChatApi* | [**chat**](docs/AIChatApi.md#chat) | **POST** /api/v1/ai/chat | Chat with AI assistant *AIChatApi* | [**deleteConversation**](docs/AIChatApi.md#deleteconversation) | **DELETE** /api/v1/ai/conversations/{conversationId} | Delete conversation *AIChatApi* | [**discard**](docs/AIChatApi.md#discard) | **POST** /api/v1/ai/reorganization/{planId}/discard | Discard a proposed reorganisation plan *AIChatApi* | [**get3**](docs/AIChatApi.md#get3) | **GET** /api/v1/ai/reorganization/{planId} | Get a reorganisation plan proposed by the AI assistant *AIChatApi* | [**getConversationHistory**](docs/AIChatApi.md#getconversationhistory) | **GET** /api/v1/ai/conversations/{conversationId} | Get conversation history *AIChatApi* | [**listConversations**](docs/AIChatApi.md#listconversations) | **GET** /api/v1/ai/conversations | List conversations *AIChatApi* | [**proposeByKind**](docs/AIChatApi.md#proposebykind) | **POST** /api/v1/ai/reorganization/by-kind | Propose a reorganisation by kind of document — no model involved *AIEmbeddingsApi* | [**backfill1**](docs/AIEmbeddingsApi.md#backfill1) | **POST** /api/v1/ai/embeddings/backfill | Embed existing documents *AIEmbeddingsApi* | [**backfillStatus1**](docs/AIEmbeddingsApi.md#backfillstatus1) | **GET** /api/v1/ai/embeddings/backfill/{jobId} | Progress of an embedding backfill job *AISettingsApi* | [**deleteSettings**](docs/AISettingsApi.md#deletesettings) | **DELETE** /api/v1/settings/ai | Reset my AI settings *AISettingsApi* | [**getSettings**](docs/AISettingsApi.md#getsettings) | **GET** /api/v1/settings/ai | Get my AI settings *AISettingsApi* | [**listModels**](docs/AISettingsApi.md#listmodels) | **POST** /api/v1/settings/ai/models | List the provider\'s chat models *AISettingsApi* | [**saveSettings**](docs/AISettingsApi.md#savesettings) | **PUT** /api/v1/settings/ai | Save my AI settings *AISettingsApi* | [**testConnection**](docs/AISettingsApi.md#testconnection) | **POST** /api/v1/settings/ai/test | Test AI provider connection *AuditControllerApi* | [**auditIntegrityStatus**](docs/AuditControllerApi.md#auditintegritystatus) | **GET** /api/v1/audit/verify/status | Last scheduled audit chain verification *AuditControllerApi* | [**getAuditTrail**](docs/AuditControllerApi.md#getaudittrail) | **GET** /api/v1/audit/{id} | Get audit trail for a resource *AuditControllerApi* | [**searchAuditTrail**](docs/AuditControllerApi.md#searchaudittrail) | **POST** /api/v1/audit/search | Search for audit trails *AuditControllerApi* | [**verifyChain**](docs/AuditControllerApi.md#verifychain) | **GET** /api/v1/audit/verify | Verify audit chain integrity *DashboardApi* | [**getDashboardStatistics**](docs/DashboardApi.md#getdashboardstatistics) | **GET** /api/v1/dashboard/statistics | Get dashboard statistics *DocumentControllerApi* | [**createBlankDocument**](docs/DocumentControllerApi.md#createblankdocument) | **POST** /api/v1/documents/create-blank | Create a blank document from template *DocumentControllerApi* | [**deleteDocumentMetadata**](docs/DocumentControllerApi.md#deletedocumentmetadata) | **DELETE** /api/v1/documents/{documentId}/metadata | Delete specific metadata keys *DocumentControllerApi* | [**downloadDocument**](docs/DocumentControllerApi.md#downloaddocument) | **GET** /api/v1/documents/{documentId}/download | Download a document *DocumentControllerApi* | [**downloadForOnlyOffice**](docs/DocumentControllerApi.md#downloadforonlyoffice) | **GET** /api/v1/documents/{documentId}/onlyoffice-download | Download document for OnlyOffice *DocumentControllerApi* | [**downloadMultipleDocumentsAsZip**](docs/DocumentControllerApi.md#downloadmultipledocumentsaszip) | **POST** /api/v1/documents/download-multiple | Download multiple documents as ZIP *DocumentControllerApi* | [**getDocumentAncestors**](docs/DocumentControllerApi.md#getdocumentancestors) | **GET** /api/v1/documents/{documentId}/ancestors | Get document ancestors *DocumentControllerApi* | [**getDocumentInfo**](docs/DocumentControllerApi.md#getdocumentinfo) | **GET** /api/v1/documents/{documentId}/info | Get information of a document *DocumentControllerApi* | [**getDocumentIntegrity**](docs/DocumentControllerApi.md#getdocumentintegrity) | **GET** /api/v1/documents/{documentId}/integrity | Get a document\'s integrity ledger *DocumentControllerApi* | [**getDocumentMetadata**](docs/DocumentControllerApi.md#getdocumentmetadata) | **POST** /api/v1/documents/{documentId}/search/metadata | Search metadata of a document *DocumentControllerApi* | [**getDocumentPosition**](docs/DocumentControllerApi.md#getdocumentposition) | **GET** /api/v1/documents/{documentId}/position | Get document position in folder *DocumentControllerApi* | [**replaceDocumentContent**](docs/DocumentControllerApi.md#replacedocumentcontent) | **PUT** /api/v1/documents/{documentId}/replace-content | Replace document content *DocumentControllerApi* | [**replaceDocumentMetadata**](docs/DocumentControllerApi.md#replacedocumentmetadata) | **PUT** /api/v1/documents/{documentId}/replace-metadata | Replace document metadata *DocumentControllerApi* | [**searchDocumentIdsByMetadata**](docs/DocumentControllerApi.md#searchdocumentidsbymetadata) | **POST** /api/v1/documents/search/ids-by-metadata | Search document IDs by metadata *DocumentControllerApi* | [**updateDocumentMetadata**](docs/DocumentControllerApi.md#updatedocumentmetadata) | **PATCH** /api/v1/documents/{documentId}/metadata | Update document metadata *DocumentControllerApi* | [**uploadDocument**](docs/DocumentControllerApi.md#uploaddocument) | **POST** /api/v1/documents/upload-multiple | Upload multiple documents *DocumentControllerApi* | [**uploadDocument1**](docs/DocumentControllerApi.md#uploaddocument1) | **POST** /api/v1/documents/upload | Upload a single document *DocumentInsightsApi* | [**backfill**](docs/DocumentInsightsApi.md#backfill) | **POST** /api/v1/ai/insights/backfill | Enrich existing documents *DocumentInsightsApi* | [**backfillStatus**](docs/DocumentInsightsApi.md#backfillstatus) | **GET** /api/v1/ai/insights/backfill/{jobId} | Progress of a backfill job *DocumentInsightsApi* | [**facets**](docs/DocumentInsightsApi.md#facets) | **GET** /api/v1/ai/insights/facets | The category and language facets of the library *DocumentInsightsApi* | [**getInsights**](docs/DocumentInsightsApi.md#getinsights) | **GET** /api/v1/documents/{documentId}/insights | Get the insights of a document *DocumentInsightsApi* | [**setCategory**](docs/DocumentInsightsApi.md#setcategory) | **PATCH** /api/v1/documents/{documentId}/insights | Correct the kind of a document *DocumentSuggestionControllerApi* | [**getSuggestions**](docs/DocumentSuggestionControllerApi.md#getsuggestions) | **GET** /api/v1/suggestions | *DocumentVersionControllerApi* | [**downloadVersion**](docs/DocumentVersionControllerApi.md#downloadversion) | **GET** /api/v1/documents/{documentId}/versions/{versionId}/download | Download a specific document version *DocumentVersionControllerApi* | [**listVersions**](docs/DocumentVersionControllerApi.md#listversions) | **GET** /api/v1/documents/{documentId}/versions | List document versions *DocumentVersionControllerApi* | [**restoreVersion**](docs/DocumentVersionControllerApi.md#restoreversion) | **POST** /api/v1/documents/{documentId}/versions/{versionId}/restore | Restore a previous document version *ESignApi* | [**cancel1**](docs/ESignApi.md#cancel1) | **POST** /api/v1/signatures/{id}/cancel | Cancel a non-terminal envelope *ESignApi* | [**cloudSubscription**](docs/ESignApi.md#cloudsubscription) | **GET** /api/v1/signatures/cloud-subscription | Cloud Signing subscription and month-to-date usage (openfilz-cloud seal provider only) *ESignApi* | [**create**](docs/ESignApi.md#create) | **POST** /api/v1/signatures | Create an envelope (sent immediately unless send=false) *ESignApi* | [**events**](docs/ESignApi.md#events) | **GET** /api/v1/signatures/{id}/events | Audit trail of one of my envelopes *ESignApi* | [**get2**](docs/ESignApi.md#get2) | **GET** /api/v1/signatures/{id} | Get one of my envelopes (recipients + fields) *ESignApi* | [**listSent**](docs/ESignApi.md#listsent) | **GET** /api/v1/signatures | List envelopes I sent for signature *ESignApi* | [**listToSign**](docs/ESignApi.md#listtosign) | **GET** /api/v1/signatures/to-sign | List envelopes waiting for my signature *ESignApi* | [**resend**](docs/ESignApi.md#resend) | **POST** /api/v1/signatures/{id}/recipients/{recipientId}/resend | Resend the signing link to a recipient (new token, previous one revoked) *ESignApi* | [**send**](docs/ESignApi.md#send) | **POST** /api/v1/signatures/{id}/send | Send a DRAFT envelope *ESignApi* | [**signedDocument**](docs/ESignApi.md#signeddocument) | **GET** /api/v1/signatures/{id}/signed-document | Download the sealed PDF of a completed envelope *ESignPublicApi* | [**decline**](docs/ESignPublicApi.md#decline) | **POST** /api/v1/public/signatures/decline | Decline to sign (voids the envelope) *ESignPublicApi* | [**document**](docs/ESignPublicApi.md#document) | **GET** /api/v1/public/signatures/document | Stream the source PDF for signing *ESignPublicApi* | [**markViewed**](docs/ESignPublicApi.md#markviewed) | **POST** /api/v1/public/signatures/viewed | Record that the recipient opened the document *ESignPublicApi* | [**requestOtp**](docs/ESignPublicApi.md#requestotp) | **POST** /api/v1/public/signatures/otp/request | Send a one-time access code to the recipient (EMAIL_OTP / SMS_OTP) *ESignPublicApi* | [**sign**](docs/ESignPublicApi.md#sign) | **POST** /api/v1/public/signatures/sign | Submit the recipient\'s fields and sign *ESignPublicApi* | [**verifyOtp**](docs/ESignPublicApi.md#verifyotp) | **POST** /api/v1/public/signatures/otp/verify | Verify the one-time access code *ESignPublicApi* | [**view**](docs/ESignPublicApi.md#view) | **GET** /api/v1/public/signatures | Resolve a signing token to its envelope view *ESignTemplatesApi* | [**_delete**](docs/ESignTemplatesApi.md#_delete) | **DELETE** /api/v1/signature-templates/{id} | Delete a template *ESignTemplatesApi* | [**create1**](docs/ESignTemplatesApi.md#create1) | **POST** /api/v1/signature-templates | Create a template *ESignTemplatesApi* | [**get**](docs/ESignTemplatesApi.md#get) | **GET** /api/v1/signature-templates/{id} | Get a template *ESignTemplatesApi* | [**instantiate**](docs/ESignTemplatesApi.md#instantiate) | **POST** /api/v1/signature-templates/{id}/envelopes | Create (and send) an envelope from a template *ESignTemplatesApi* | [**list**](docs/ESignTemplatesApi.md#list) | **GET** /api/v1/signature-templates | List my templates *ESignTemplatesApi* | [**update**](docs/ESignTemplatesApi.md#update) | **PUT** /api/v1/signature-templates/{id} | Update a template *FavoritesApi* | [**addFavorite**](docs/FavoritesApi.md#addfavorite) | **POST** /api/v1/favorites/{documentId} | Add document to favorites *FavoritesApi* | [**isFavorite**](docs/FavoritesApi.md#isfavorite) | **GET** /api/v1/favorites/{documentId}/is-favorite | Check favorite status *FavoritesApi* | [**removeFavorite**](docs/FavoritesApi.md#removefavorite) | **DELETE** /api/v1/favorites/{documentId} | Remove document from favorites *FavoritesApi* | [**toggleFavorite**](docs/FavoritesApi.md#togglefavorite) | **PUT** /api/v1/favorites/{documentId}/toggle | Toggle favorite status *FileControllerApi* | [**copyFiles**](docs/FileControllerApi.md#copyfiles) | **POST** /api/v1/files/copy | Copy files *FileControllerApi* | [**deleteFiles**](docs/FileControllerApi.md#deletefiles) | **DELETE** /api/v1/files | Delete files *FileControllerApi* | [**moveFiles**](docs/FileControllerApi.md#movefiles) | **POST** /api/v1/files/move | Move files *FileControllerApi* | [**renameFile**](docs/FileControllerApi.md#renamefile) | **PUT** /api/v1/files/{fileId}/rename | Rename a file *FileControllerApi* | [**unzipFile**](docs/FileControllerApi.md#unzipfile) | **POST** /api/v1/files/{fileId}/unzip | Extract a ZIP file *FolderControllerApi* | [**copyFolders**](docs/FolderControllerApi.md#copyfolders) | **POST** /api/v1/folders/copy | Copy folders *FolderControllerApi* | [**countFolderElements**](docs/FolderControllerApi.md#countfolderelements) | **GET** /api/v1/folders/count | Count files and subfolders contained in a given folder - return 0 if empty or not exists *FolderControllerApi* | [**createFolder**](docs/FolderControllerApi.md#createfolder) | **POST** /api/v1/folders | Create a new folder *FolderControllerApi* | [**deleteFolders**](docs/FolderControllerApi.md#deletefolders) | **DELETE** /api/v1/folders | Delete folders *FolderControllerApi* | [**listFolder**](docs/FolderControllerApi.md#listfolder) | **GET** /api/v1/folders/list | List files and subfolders contained in a given folder *FolderControllerApi* | [**moveFolders**](docs/FolderControllerApi.md#movefolders) | **POST** /api/v1/folders/move | Move folders *FolderControllerApi* | [**renameFolder**](docs/FolderControllerApi.md#renamefolder) | **PUT** /api/v1/folders/{folderId}/rename | Rename a folder *McpDiscoveryControllerApi* | [**authorizationServerMetadata**](docs/McpDiscoveryControllerApi.md#authorizationservermetadata) | **GET** /.well-known/oauth-authorization-server | *McpDiscoveryControllerApi* | [**protectedResourceMetadata**](docs/McpDiscoveryControllerApi.md#protectedresourcemetadata) | **GET** /.well-known/oauth-protected-resource | *MetadataKeyControllerApi* | [**listMetadataKeys**](docs/MetadataKeyControllerApi.md#listmetadatakeys) | **GET** /api/v1/documents/metadata-keys | List metadata keys *PDFToolsApi* | [**info**](docs/PDFToolsApi.md#info) | **GET** /api/v1/pdf/{documentId}/info | Describe a stored PDF *PDFToolsApi* | [**merge**](docs/PDFToolsApi.md#merge) | **POST** /api/v1/pdf/merge | Merge PDFs *PDFToolsApi* | [**organize**](docs/PDFToolsApi.md#organize) | **POST** /api/v1/pdf/organize | Reorganise the pages of a PDF *PDFToolsApi* | [**rotate**](docs/PDFToolsApi.md#rotate) | **POST** /api/v1/pdf/rotate | Rotate pages *PDFToolsApi* | [**split**](docs/PDFToolsApi.md#split) | **POST** /api/v1/pdf/split | Split a PDF *QuotaAdministrationApi* | [**clearUserQuota**](docs/QuotaAdministrationApi.md#clearuserquota) | **DELETE** /api/v1/admin/quotas/users/{username} | Remove one user\'s own limit *QuotaAdministrationApi* | [**getUser**](docs/QuotaAdministrationApi.md#getuser) | **GET** /api/v1/admin/quotas/users/{username} | Get one user\'s storage *QuotaAdministrationApi* | [**listUsers**](docs/QuotaAdministrationApi.md#listusers) | **GET** /api/v1/admin/quotas/users | List users\' storage *QuotaAdministrationApi* | [**overview**](docs/QuotaAdministrationApi.md#overview) | **GET** /api/v1/admin/quotas | Quota overview *QuotaAdministrationApi* | [**setUserQuota**](docs/QuotaAdministrationApi.md#setuserquota) | **PUT** /api/v1/admin/quotas/users/{username} | Set one user\'s own limit *QuotasApi* | [**myQuota**](docs/QuotasApi.md#myquota) | **GET** /api/v1/quotas/me | Get my storage quota *SettingsApi* | [**get1**](docs/SettingsApi.md#get1) | **GET** /api/v1/settings/ai/preferences | The caller\'s smart-filing preferences *SettingsApi* | [**getSettings1**](docs/SettingsApi.md#getsettings1) | **GET** /api/v1/settings | Get user\'s settings *SettingsApi* | [**save**](docs/SettingsApi.md#save) | **PUT** /api/v1/settings/ai/preferences | Save the caller\'s smart-filing preferences *SmartFilingApi* | [**file**](docs/SmartFilingApi.md#file) | **POST** /api/v1/ai/auto-file | File existing documents on demand *SmartFilingApi* | [**fileInbox**](docs/SmartFilingApi.md#fileinbox) | **POST** /api/v1/ai/auto-file/inbox | File everything lying loose in the caller\'s Inbox *SmartFilingApi* | [**job**](docs/SmartFilingApi.md#job) | **GET** /api/v1/ai/auto-file/{jobId} | Progress and outcome of a filing job *SmartFilingApi* | [**jobs**](docs/SmartFilingApi.md#jobs) | **POST** /api/v1/ai/auto-file/jobs | Progress and outcome of several filing jobs *SmartFilingApi* | [**lastFiling**](docs/SmartFilingApi.md#lastfiling) | **GET** /api/v1/ai/auto-file/document/{documentId} | The latest filing record of a document (the \"Filed by OpenFilz\" chip) *SmartFilingApi* | [**undo**](docs/SmartFilingApi.md#undo) | **POST** /api/v1/ai/auto-file/{jobId}/undo | Move every document the job filed back where it came from *SmartFilingApi* | [**undoFiling**](docs/SmartFilingApi.md#undofiling) | **POST** /api/v1/ai/auto-file/filing/{planId}/undo | Move one filed document back (the chip\'s \"Move back\") *TusControllerApi* | [**_options**](docs/TusControllerApi.md#_options) | **OPTIONS** /api/v1/tus | TUS capability discovery *TusControllerApi* | [**cancelUpload**](docs/TusControllerApi.md#cancelupload) | **DELETE** /api/v1/tus/{uploadId} | Cancel upload *TusControllerApi* | [**createUpload**](docs/TusControllerApi.md#createupload) | **POST** /api/v1/tus | Create new TUS upload *TusControllerApi* | [**finalizeUpload**](docs/TusControllerApi.md#finalizeupload) | **POST** /api/v1/tus/{uploadId}/finalize | Finalize upload *TusControllerApi* | [**getConfig**](docs/TusControllerApi.md#getconfig) | **GET** /api/v1/tus/config | Get TUS configuration *TusControllerApi* | [**getUploadInfo**](docs/TusControllerApi.md#getuploadinfo) | **GET** /api/v1/tus/{uploadId}/info | Get upload information *TusControllerApi* | [**getUploadOffset**](docs/TusControllerApi.md#getuploadoffset) | **HEAD** /api/v1/tus/{uploadId} | Get upload progress *TusControllerApi* | [**isUploadComplete**](docs/TusControllerApi.md#isuploadcomplete) | **GET** /api/v1/tus/{uploadId}/complete | Check upload completion *TusControllerApi* | [**uploadChunk**](docs/TusControllerApi.md#uploadchunk) | **PATCH** /api/v1/tus/{uploadId} | Upload chunk *WorkflowsApi* | [**cancel**](docs/WorkflowsApi.md#cancel) | **POST** /api/v1/workflows/instances/{id}/cancel | Cancel a running instance (initiator) *WorkflowsApi* | [**complete**](docs/WorkflowsApi.md#complete) | **POST** /api/v1/workflows/tasks/{id}/complete | Take a transition on a task I am a candidate of *WorkflowsApi* | [**createDefinition**](docs/WorkflowsApi.md#createdefinition) | **POST** /api/v1/workflows/definitions | Create a workflow definition (400 with the problem list when invalid) *WorkflowsApi* | [**deleteDefinition**](docs/WorkflowsApi.md#deletedefinition) | **DELETE** /api/v1/workflows/definitions/{id} | Delete a workflow definition (409 while instances are running) *WorkflowsApi* | [**getDefinition**](docs/WorkflowsApi.md#getdefinition) | **GET** /api/v1/workflows/definitions/{id} | Get a workflow definition *WorkflowsApi* | [**getInstance**](docs/WorkflowsApi.md#getinstance) | **GET** /api/v1/workflows/instances/{id} | One instance with its snapshot spec, open task and history *WorkflowsApi* | [**listDefinitions**](docs/WorkflowsApi.md#listdefinitions) | **GET** /api/v1/workflows/definitions | List the workflow definitions the caller may see (mine = created by the caller) *WorkflowsApi* | [**listInstances**](docs/WorkflowsApi.md#listinstances) | **GET** /api/v1/workflows/instances | List instances (monitor), newest first *WorkflowsApi* | [**myTasks**](docs/WorkflowsApi.md#mytasks) | **GET** /api/v1/workflows/tasks/mine | Open tasks I can act on (by e-mail or role) *WorkflowsApi* | [**myTasksCount**](docs/WorkflowsApi.md#mytaskscount) | **GET** /api/v1/workflows/tasks/mine/count | Number of open tasks I can act on (sidebar badge) *WorkflowsApi* | [**reassign**](docs/WorkflowsApi.md#reassign) | **POST** /api/v1/workflows/tasks/{id}/reassign | Hand a task to other people (initiator or current candidate) *WorkflowsApi* | [**start**](docs/WorkflowsApi.md#start) | **POST** /api/v1/workflows/instances | Start a workflow on a document (409 when one is already running) *WorkflowsApi* | [**summary**](docs/WorkflowsApi.md#summary) | **GET** /api/v1/workflows/instances/summary | Counts for the monitor header *WorkflowsApi* | [**updateDefinition**](docs/WorkflowsApi.md#updatedefinition) | **PUT** /api/v1/workflows/definitions/{id} | Update a workflow definition (running instances keep their snapshot) *WorkflowsApi* | [**validateDefinition**](docs/WorkflowsApi.md#validatedefinition) | **POST** /api/v1/workflows/definitions/validate | Validate a definition without saving it ### Documentation For Models - [AiChatConversation](docs/AiChatConversation.md) - [AiChatRequest](docs/AiChatRequest.md) - [AiChatResponse](docs/AiChatResponse.md) - [AiConnectionTestResult](docs/AiConnectionTestResult.md) - [AiModelsResponse](docs/AiModelsResponse.md) - [AiPreferencesView](docs/AiPreferencesView.md) - [AiSettingsResponse](docs/AiSettingsResponse.md) - [AncestorInfo](docs/AncestorInfo.md) - [ApplySignatureRequest](docs/ApplySignatureRequest.md) - [AuditIntegrityStatusResponse](docs/AuditIntegrityStatusResponse.md) - [AuditLog](docs/AuditLog.md) - [AuditLogDetails](docs/AuditLogDetails.md) - [AuditLogDetailsOneOf](docs/AuditLogDetailsOneOf.md) - [AuditVerificationResult](docs/AuditVerificationResult.md) - [AutoFileInboxRequest](docs/AutoFileInboxRequest.md) - [AutoFileJobView](docs/AutoFileJobView.md) - [AutoFileJobsRequest](docs/AutoFileJobsRequest.md) - [AutoFileRequest](docs/AutoFileRequest.md) - [AutoFileTicket](docs/AutoFileTicket.md) - [BrokenLink](docs/BrokenLink.md) - [CancelInstanceRequest](docs/CancelInstanceRequest.md) - [CloudSignatureSubscription](docs/CloudSignatureSubscription.md) - [CompleteTaskRequest](docs/CompleteTaskRequest.md) - [CopyAudit](docs/CopyAudit.md) - [CopyRequest](docs/CopyRequest.md) - [CopyResponse](docs/CopyResponse.md) - [CreateBlankDocumentRequest](docs/CreateBlankDocumentRequest.md) - [CreateFolderAudit](docs/CreateFolderAudit.md) - [CreateFolderRequest](docs/CreateFolderRequest.md) - [CreateSignatureEnvelopeRequest](docs/CreateSignatureEnvelopeRequest.md) - [DashboardStatisticsResponse](docs/DashboardStatisticsResponse.md) - [DeclineSignatureRequest](docs/DeclineSignatureRequest.md) - [DeleteAudit](docs/DeleteAudit.md) - [DeleteMetadataAudit](docs/DeleteMetadataAudit.md) - [DeleteMetadataRequest](docs/DeleteMetadataRequest.md) - [DeleteRequest](docs/DeleteRequest.md) - [DocumentInfo](docs/DocumentInfo.md) - [DocumentInsightView](docs/DocumentInsightView.md) - [DocumentIntegrityRecord](docs/DocumentIntegrityRecord.md) - [DocumentPosition](docs/DocumentPosition.md) - [DocumentVersionInfo](docs/DocumentVersionInfo.md) - [ElementInfo](docs/ElementInfo.md) - [EmbeddingBackfillRequest](docs/EmbeddingBackfillRequest.md) - [EmbeddingBackfillStatus](docs/EmbeddingBackfillStatus.md) - [ErrorResponse](docs/ErrorResponse.md) - [Facet](docs/Facet.md) - [FileTypeStats](docs/FileTypeStats.md) - [FilingOutcome](docs/FilingOutcome.md) - [FilterInput](docs/FilterInput.md) - [FolderElementInfo](docs/FolderElementInfo.md) - [FolderResponse](docs/FolderResponse.md) - [InsightBackfillRequest](docs/InsightBackfillRequest.md) - [InsightBackfillStatus](docs/InsightBackfillStatus.md) - [InsightCategoryUpdate](docs/InsightCategoryUpdate.md) - [InsightFacets](docs/InsightFacets.md) - [InstantiateTemplateRequest](docs/InstantiateTemplateRequest.md) - [Item](docs/Item.md) - [ItemResult](docs/ItemResult.md) - [ListAiModelsRequest](docs/ListAiModelsRequest.md) - [MergeRequest](docs/MergeRequest.md) - [MergeSource](docs/MergeSource.md) - [MetadataKeySuggestion](docs/MetadataKeySuggestion.md) - [MoveAudit](docs/MoveAudit.md) - [MoveRequest](docs/MoveRequest.md) - [MyStorageQuota](docs/MyStorageQuota.md) - [MyTasksCountDTO](docs/MyTasksCountDTO.md) - [OrganizeRequest](docs/OrganizeRequest.md) - [OutputTarget](docs/OutputTarget.md) - [PageInstruction](docs/PageInstruction.md) - [PdfInfo](docs/PdfInfo.md) - [PdfOperationResponse](docs/PdfOperationResponse.md) - [PdfOutlineEntry](docs/PdfOutlineEntry.md) - [PdfOutputInfo](docs/PdfOutputInfo.md) - [PdfPageInfo](docs/PdfPageInfo.md) - [PdfTransformAudit](docs/PdfTransformAudit.md) - [PerDefinition](docs/PerDefinition.md) - [PublicSignatureView](docs/PublicSignatureView.md) - [QuotaOverview](docs/QuotaOverview.md) - [QuotaUsage](docs/QuotaUsage.md) - [QuotaUserPage](docs/QuotaUserPage.md) - [ReassignTaskRequest](docs/ReassignTaskRequest.md) - [RenameAudit](docs/RenameAudit.md) - [RenameRequest](docs/RenameRequest.md) - [ReorganizationApplyRequest](docs/ReorganizationApplyRequest.md) - [ReorganizationApplyResult](docs/ReorganizationApplyResult.md) - [ReorganizationByKindRequest](docs/ReorganizationByKindRequest.md) - [ReorganizationPlanView](docs/ReorganizationPlanView.md) - [ReplaceAudit](docs/ReplaceAudit.md) - [RestoreVersionAudit](docs/RestoreVersionAudit.md) - [RestoreVersionResponse](docs/RestoreVersionResponse.md) - [RoleBinding](docs/RoleBinding.md) - [RotateRequest](docs/RotateRequest.md) - [SaveAiPreferencesRequest](docs/SaveAiPreferencesRequest.md) - [SaveAiSettingsRequest](docs/SaveAiSettingsRequest.md) - [SaveWorkflowDefinitionRequest](docs/SaveWorkflowDefinitionRequest.md) - [SearchByAuditLogRequest](docs/SearchByAuditLogRequest.md) - [SearchByMetadataRequest](docs/SearchByMetadataRequest.md) - [SearchMetadataRequest](docs/SearchMetadataRequest.md) - [Settings](docs/Settings.md) - [SignatureEnvelopeDTO](docs/SignatureEnvelopeDTO.md) - [SignatureEventDTO](docs/SignatureEventDTO.md) - [SignatureFieldDTO](docs/SignatureFieldDTO.md) - [SignatureFieldInput](docs/SignatureFieldInput.md) - [SignatureFieldPlacement](docs/SignatureFieldPlacement.md) - [SignatureFieldValue](docs/SignatureFieldValue.md) - [SignatureRecipientDTO](docs/SignatureRecipientDTO.md) - [SignatureRecipientInput](docs/SignatureRecipientInput.md) - [SignatureTemplateDTO](docs/SignatureTemplateDTO.md) - [SignatureTemplateField](docs/SignatureTemplateField.md) - [SignatureTemplateRequest](docs/SignatureTemplateRequest.md) - [SignatureTemplateRole](docs/SignatureTemplateRole.md) - [SortInput](docs/SortInput.md) - [SplitOutput](docs/SplitOutput.md) - [SplitRequest](docs/SplitRequest.md) - [StartWorkflowRequest](docs/StartWorkflowRequest.md) - [StorageBreakdown](docs/StorageBreakdown.md) - [Suggest](docs/Suggest.md) - [TusConfigResponse](docs/TusConfigResponse.md) - [TusFinalizeRequest](docs/TusFinalizeRequest.md) - [TusUploadInfo](docs/TusUploadInfo.md) - [UnzipRequest](docs/UnzipRequest.md) - [UnzipResponse](docs/UnzipResponse.md) - [UnzipSkippedEntry](docs/UnzipSkippedEntry.md) - [UpdateMetadataAudit](docs/UpdateMetadataAudit.md) - [UpdateMetadataRequest](docs/UpdateMetadataRequest.md) - [UploadAudit](docs/UploadAudit.md) - [UploadResponse](docs/UploadResponse.md) - [UserQuotaRequest](docs/UserQuotaRequest.md) - [VerifyOtpRequest](docs/VerifyOtpRequest.md) - [Vote](docs/Vote.md) - [WorkflowAction](docs/WorkflowAction.md) - [WorkflowActionFailureAudit](docs/WorkflowActionFailureAudit.md) - [WorkflowAssignment](docs/WorkflowAssignment.md) - [WorkflowAudit](docs/WorkflowAudit.md) - [WorkflowDefinitionDTO](docs/WorkflowDefinitionDTO.md) - [WorkflowEventDTO](docs/WorkflowEventDTO.md) - [WorkflowInstanceDTO](docs/WorkflowInstanceDTO.md) - [WorkflowInstanceDetailDTO](docs/WorkflowInstanceDetailDTO.md) - [WorkflowInstancePage](docs/WorkflowInstancePage.md) - [WorkflowProblem](docs/WorkflowProblem.md) - [WorkflowReview](docs/WorkflowReview.md) - [WorkflowReviewProgressDTO](docs/WorkflowReviewProgressDTO.md) - [WorkflowSpec](docs/WorkflowSpec.md) - [WorkflowState](docs/WorkflowState.md) - [WorkflowSummaryDTO](docs/WorkflowSummaryDTO.md) - [WorkflowTaskDTO](docs/WorkflowTaskDTO.md) - [WorkflowTransition](docs/WorkflowTransition.md) - [WorkflowValidationResult](docs/WorkflowValidationResult.md) ## Documentation For Authorization Authentication schemes defined for the API: ### keycloak_auth - **Type**: Bearer authentication (JWT)