Metadata-Version: 2.4
Name: openfilz_sdk
Version: 1.3.6
Summary: openfilz-api
Home-page: 
Author: OpenAPI Generator community
Author-email: OpenAPI Generator Community <team@openapitools.org>
License: AGPL-3.0
Project-URL: Repository, https://github.com/openfilz/openfilz-core
Keywords: OpenAPI,OpenAPI-Generator,openfilz-api
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: urllib3<3.0.0,>=2.1.0
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: pydantic>=2.11
Requires-Dist: typing-extensions>=4.7.1
Dynamic: author

# openfilz-sdk-python
API for Document Management System

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.0.0
- Package version: 1.3.6
- Generator version: 7.23.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python 3.10+

## Installation & Usage
### pip install

If the python package is hosted on a repository, you can install directly using:

```sh
pip install git+https://github.com/openfilz/openfilz-core.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/openfilz/openfilz-core.git`)

Then import the package:
```python
import openfilz_sdk
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import openfilz_sdk
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import openfilz_sdk
from openfilz_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8081
# See configuration.py for a list of all supported configuration parameters.
configuration = openfilz_sdk.Configuration(
    host = "http://localhost:8081"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): keycloak_auth
configuration = openfilz_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with openfilz_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openfilz_sdk.AIChatApi(api_client)
    plan_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | 
    reorganization_apply_request = openfilz_sdk.ReorganizationApplyRequest() # ReorganizationApplyRequest |  (optional)

    try:
        # Apply a proposed reorganisation plan
        api_response = api_instance.apply(plan_id, reorganization_apply_request=reorganization_apply_request)
        print("The response of AIChatApi->apply:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AIChatApi->apply: %s\n" % e)

```

## 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* | [**delete_conversation**](docs/AIChatApi.md#delete_conversation) | **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* | [**get_conversation_history**](docs/AIChatApi.md#get_conversation_history) | **GET** /api/v1/ai/conversations/{conversationId} | Get conversation history
*AIChatApi* | [**list_conversations**](docs/AIChatApi.md#list_conversations) | **GET** /api/v1/ai/conversations | List conversations
*AISettingsApi* | [**delete_settings**](docs/AISettingsApi.md#delete_settings) | **DELETE** /api/v1/settings/ai | Reset my AI settings
*AISettingsApi* | [**get_settings**](docs/AISettingsApi.md#get_settings) | **GET** /api/v1/settings/ai | Get my AI settings
*AISettingsApi* | [**list_models**](docs/AISettingsApi.md#list_models) | **POST** /api/v1/settings/ai/models | List the provider&#39;s chat models
*AISettingsApi* | [**save_settings**](docs/AISettingsApi.md#save_settings) | **PUT** /api/v1/settings/ai | Save my AI settings
*AISettingsApi* | [**test_connection**](docs/AISettingsApi.md#test_connection) | **POST** /api/v1/settings/ai/test | Test AI provider connection
*DashboardApi* | [**get_dashboard_statistics**](docs/DashboardApi.md#get_dashboard_statistics) | **GET** /api/v1/dashboard/statistics | Get dashboard statistics
*DocumentInsightsApi* | [**backfill**](docs/DocumentInsightsApi.md#backfill) | **POST** /api/v1/ai/insights/backfill | Enrich existing documents
*DocumentInsightsApi* | [**backfill_status**](docs/DocumentInsightsApi.md#backfill_status) | **GET** /api/v1/ai/insights/backfill/{jobId} | Progress of a backfill job
*DocumentInsightsApi* | [**get_insights**](docs/DocumentInsightsApi.md#get_insights) | **GET** /api/v1/documents/{documentId}/insights | Get the insights of a document
*FavoritesApi* | [**add_favorite**](docs/FavoritesApi.md#add_favorite) | **POST** /api/v1/favorites/{documentId} | Add document to favorites
*FavoritesApi* | [**is_favorite**](docs/FavoritesApi.md#is_favorite) | **GET** /api/v1/favorites/{documentId}/is-favorite | Check favorite status
*FavoritesApi* | [**remove_favorite**](docs/FavoritesApi.md#remove_favorite) | **DELETE** /api/v1/favorites/{documentId} | Remove document from favorites
*FavoritesApi* | [**toggle_favorite**](docs/FavoritesApi.md#toggle_favorite) | **PUT** /api/v1/favorites/{documentId}/toggle | Toggle favorite status
*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
*SettingsApi* | [**get1**](docs/SettingsApi.md#get1) | **GET** /api/v1/settings/ai/preferences | The caller&#39;s smart-filing preferences
*SettingsApi* | [**get_settings1**](docs/SettingsApi.md#get_settings1) | **GET** /api/v1/settings | Get user&#39;s settings
*SettingsApi* | [**save**](docs/SettingsApi.md#save) | **PUT** /api/v1/settings/ai/preferences | Save the caller&#39;s smart-filing preferences
*SmartFilingApi* | [**file**](docs/SmartFilingApi.md#file) | **POST** /api/v1/ai/auto-file | File existing documents on demand
*SmartFilingApi* | [**job**](docs/SmartFilingApi.md#job) | **GET** /api/v1/ai/auto-file/{jobId} | Progress and outcome of a filing job
*SmartFilingApi* | [**last_filing**](docs/SmartFilingApi.md#last_filing) | **GET** /api/v1/ai/auto-file/document/{documentId} | The latest filing record of a document (the \&quot;Filed by OpenFilz\&quot; 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* | [**undo_filing**](docs/SmartFilingApi.md#undo_filing) | **POST** /api/v1/ai/auto-file/filing/{planId}/undo | Move one filed document back (the chip&#39;s \&quot;Move back\&quot;)
*AuditControllerApi* | [**get_audit_trail**](docs/AuditControllerApi.md#get_audit_trail) | **GET** /api/v1/audit/{id} | Get audit trail for a resource
*AuditControllerApi* | [**search_audit_trail**](docs/AuditControllerApi.md#search_audit_trail) | **POST** /api/v1/audit/search | Search for audit trails
*AuditControllerApi* | [**verify_chain**](docs/AuditControllerApi.md#verify_chain) | **GET** /api/v1/audit/verify | Verify audit chain integrity
*DocumentControllerApi* | [**create_blank_document**](docs/DocumentControllerApi.md#create_blank_document) | **POST** /api/v1/documents/create-blank | Create a blank document from template
*DocumentControllerApi* | [**delete_document_metadata**](docs/DocumentControllerApi.md#delete_document_metadata) | **DELETE** /api/v1/documents/{documentId}/metadata | Delete specific metadata keys
*DocumentControllerApi* | [**download_document**](docs/DocumentControllerApi.md#download_document) | **GET** /api/v1/documents/{documentId}/download | Download a document
*DocumentControllerApi* | [**download_for_only_office**](docs/DocumentControllerApi.md#download_for_only_office) | **GET** /api/v1/documents/{documentId}/onlyoffice-download | Download document for OnlyOffice
*DocumentControllerApi* | [**download_multiple_documents_as_zip**](docs/DocumentControllerApi.md#download_multiple_documents_as_zip) | **POST** /api/v1/documents/download-multiple | Download multiple documents as ZIP
*DocumentControllerApi* | [**get_document_ancestors**](docs/DocumentControllerApi.md#get_document_ancestors) | **GET** /api/v1/documents/{documentId}/ancestors | Get document ancestors
*DocumentControllerApi* | [**get_document_info**](docs/DocumentControllerApi.md#get_document_info) | **GET** /api/v1/documents/{documentId}/info | Get information of a document
*DocumentControllerApi* | [**get_document_metadata**](docs/DocumentControllerApi.md#get_document_metadata) | **POST** /api/v1/documents/{documentId}/search/metadata | Search metadata of a document
*DocumentControllerApi* | [**get_document_position**](docs/DocumentControllerApi.md#get_document_position) | **GET** /api/v1/documents/{documentId}/position | Get document position in folder
*DocumentControllerApi* | [**replace_document_content**](docs/DocumentControllerApi.md#replace_document_content) | **PUT** /api/v1/documents/{documentId}/replace-content | Replace document content
*DocumentControllerApi* | [**replace_document_metadata**](docs/DocumentControllerApi.md#replace_document_metadata) | **PUT** /api/v1/documents/{documentId}/replace-metadata | Replace document metadata
*DocumentControllerApi* | [**search_document_ids_by_metadata**](docs/DocumentControllerApi.md#search_document_ids_by_metadata) | **POST** /api/v1/documents/search/ids-by-metadata | Search document IDs by metadata
*DocumentControllerApi* | [**update_document_metadata**](docs/DocumentControllerApi.md#update_document_metadata) | **PATCH** /api/v1/documents/{documentId}/metadata | Update document metadata
*DocumentControllerApi* | [**upload_document**](docs/DocumentControllerApi.md#upload_document) | **POST** /api/v1/documents/upload-multiple | Upload multiple documents
*DocumentControllerApi* | [**upload_document1**](docs/DocumentControllerApi.md#upload_document1) | **POST** /api/v1/documents/upload | Upload a single document
*DocumentSuggestionControllerApi* | [**get_suggestions**](docs/DocumentSuggestionControllerApi.md#get_suggestions) | **GET** /api/v1/suggestions | 
*DocumentVersionControllerApi* | [**download_version**](docs/DocumentVersionControllerApi.md#download_version) | **GET** /api/v1/documents/{documentId}/versions/{versionId}/download | Download a specific document version
*DocumentVersionControllerApi* | [**list_versions**](docs/DocumentVersionControllerApi.md#list_versions) | **GET** /api/v1/documents/{documentId}/versions | List document versions
*DocumentVersionControllerApi* | [**restore_version**](docs/DocumentVersionControllerApi.md#restore_version) | **POST** /api/v1/documents/{documentId}/versions/{versionId}/restore | Restore a previous document version
*ESignApi* | [**cancel**](docs/ESignApi.md#cancel) | **POST** /api/v1/signatures/{id}/cancel | Cancel a non-terminal envelope
*ESignApi* | [**cloud_subscription**](docs/ESignApi.md#cloud_subscription) | **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&#x3D;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* | [**list_sent**](docs/ESignApi.md#list_sent) | **GET** /api/v1/signatures | List envelopes I sent for signature
*ESignApi* | [**list_to_sign**](docs/ESignApi.md#list_to_sign) | **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* | [**signed_document**](docs/ESignApi.md#signed_document) | **GET** /api/v1/signatures/{id}/signed-document | Download the sealed PDF of a completed envelope
*ESignTemplatesApi* | [**create1**](docs/ESignTemplatesApi.md#create1) | **POST** /api/v1/signature-templates | Create a template
*ESignTemplatesApi* | [**delete**](docs/ESignTemplatesApi.md#delete) | **DELETE** /api/v1/signature-templates/{id} | Delete 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
*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* | [**mark_viewed**](docs/ESignPublicApi.md#mark_viewed) | **POST** /api/v1/public/signatures/viewed | Record that the recipient opened the document
*ESignPublicApi* | [**request_otp**](docs/ESignPublicApi.md#request_otp) | **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&#39;s fields and sign
*ESignPublicApi* | [**verify_otp**](docs/ESignPublicApi.md#verify_otp) | **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
*FileControllerApi* | [**copy_files**](docs/FileControllerApi.md#copy_files) | **POST** /api/v1/files/copy | Copy files
*FileControllerApi* | [**delete_files**](docs/FileControllerApi.md#delete_files) | **DELETE** /api/v1/files | Delete files
*FileControllerApi* | [**move_files**](docs/FileControllerApi.md#move_files) | **POST** /api/v1/files/move | Move files
*FileControllerApi* | [**rename_file**](docs/FileControllerApi.md#rename_file) | **PUT** /api/v1/files/{fileId}/rename | Rename a file
*FolderControllerApi* | [**copy_folders**](docs/FolderControllerApi.md#copy_folders) | **POST** /api/v1/folders/copy | Copy folders
*FolderControllerApi* | [**count_folder_elements**](docs/FolderControllerApi.md#count_folder_elements) | **GET** /api/v1/folders/count | Count files and subfolders contained in a given folder - return 0 if empty or not exists
*FolderControllerApi* | [**create_folder**](docs/FolderControllerApi.md#create_folder) | **POST** /api/v1/folders | Create a new folder
*FolderControllerApi* | [**delete_folders**](docs/FolderControllerApi.md#delete_folders) | **DELETE** /api/v1/folders | Delete folders
*FolderControllerApi* | [**list_folder**](docs/FolderControllerApi.md#list_folder) | **GET** /api/v1/folders/list | List files and subfolders contained in a given folder
*FolderControllerApi* | [**move_folders**](docs/FolderControllerApi.md#move_folders) | **POST** /api/v1/folders/move | Move folders
*FolderControllerApi* | [**rename_folder**](docs/FolderControllerApi.md#rename_folder) | **PUT** /api/v1/folders/{folderId}/rename | Rename a folder
*McpDiscoveryControllerApi* | [**authorization_server_metadata**](docs/McpDiscoveryControllerApi.md#authorization_server_metadata) | **GET** /.well-known/oauth-authorization-server | 
*McpDiscoveryControllerApi* | [**protected_resource_metadata**](docs/McpDiscoveryControllerApi.md#protected_resource_metadata) | **GET** /.well-known/oauth-protected-resource | 
*TusControllerApi* | [**cancel_upload**](docs/TusControllerApi.md#cancel_upload) | **DELETE** /api/v1/tus/{uploadId} | Cancel upload
*TusControllerApi* | [**create_upload**](docs/TusControllerApi.md#create_upload) | **POST** /api/v1/tus | Create new TUS upload
*TusControllerApi* | [**finalize_upload**](docs/TusControllerApi.md#finalize_upload) | **POST** /api/v1/tus/{uploadId}/finalize | Finalize upload
*TusControllerApi* | [**get_config**](docs/TusControllerApi.md#get_config) | **GET** /api/v1/tus/config | Get TUS configuration
*TusControllerApi* | [**get_upload_info**](docs/TusControllerApi.md#get_upload_info) | **GET** /api/v1/tus/{uploadId}/info | Get upload information
*TusControllerApi* | [**get_upload_offset**](docs/TusControllerApi.md#get_upload_offset) | **HEAD** /api/v1/tus/{uploadId} | Get upload progress
*TusControllerApi* | [**is_upload_complete**](docs/TusControllerApi.md#is_upload_complete) | **GET** /api/v1/tus/{uploadId}/complete | Check upload completion
*TusControllerApi* | [**options**](docs/TusControllerApi.md#options) | **OPTIONS** /api/v1/tus | TUS capability discovery
*TusControllerApi* | [**upload_chunk**](docs/TusControllerApi.md#upload_chunk) | **PATCH** /api/v1/tus/{uploadId} | Upload chunk


## 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)
 - [AuditLog](docs/AuditLog.md)
 - [AuditLogDetails](docs/AuditLogDetails.md)
 - [AuditLogDetailsOneOf](docs/AuditLogDetailsOneOf.md)
 - [AuditVerificationResult](docs/AuditVerificationResult.md)
 - [AutoFileJobView](docs/AutoFileJobView.md)
 - [AutoFileRequest](docs/AutoFileRequest.md)
 - [AutoFileTicket](docs/AutoFileTicket.md)
 - [BrokenLink](docs/BrokenLink.md)
 - [CloudSignatureSubscription](docs/CloudSignatureSubscription.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)
 - [DocumentPosition](docs/DocumentPosition.md)
 - [DocumentVersionInfo](docs/DocumentVersionInfo.md)
 - [ElementInfo](docs/ElementInfo.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)
 - [InstantiateTemplateRequest](docs/InstantiateTemplateRequest.md)
 - [Item](docs/Item.md)
 - [ItemResult](docs/ItemResult.md)
 - [ListAiModelsRequest](docs/ListAiModelsRequest.md)
 - [MergeRequest](docs/MergeRequest.md)
 - [MergeSource](docs/MergeSource.md)
 - [MoveAudit](docs/MoveAudit.md)
 - [MoveRequest](docs/MoveRequest.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)
 - [PublicSignatureView](docs/PublicSignatureView.md)
 - [RenameAudit](docs/RenameAudit.md)
 - [RenameRequest](docs/RenameRequest.md)
 - [ReorganizationApplyRequest](docs/ReorganizationApplyRequest.md)
 - [ReorganizationApplyResult](docs/ReorganizationApplyResult.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)
 - [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)
 - [StorageBreakdown](docs/StorageBreakdown.md)
 - [Suggest](docs/Suggest.md)
 - [TusConfigResponse](docs/TusConfigResponse.md)
 - [TusFinalizeRequest](docs/TusFinalizeRequest.md)
 - [TusUploadInfo](docs/TusUploadInfo.md)
 - [UpdateMetadataAudit](docs/UpdateMetadataAudit.md)
 - [UpdateMetadataRequest](docs/UpdateMetadataRequest.md)
 - [UploadAudit](docs/UploadAudit.md)
 - [UploadResponse](docs/UploadResponse.md)
 - [VerifyOtpRequest](docs/VerifyOtpRequest.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="keycloak_auth"></a>
### keycloak_auth

- **Type**: Bearer authentication (JWT)


## Author




