openfilz-sdk-python
API for Document Management System
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 1.0.0
- Package version: 1.2.25
- 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:
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:
import openfilz_sdk
Setuptools
Install via Setuptools.
python setup.py install --user
(or sudo python setup.py install to install the package for all users)
Then import the package:
import openfilz_sdk
Tests
Execute pytest to run the tests.
Getting Started
Please follow the installation procedure and then run the following:
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)
ai_chat_request = openfilz_sdk.AiChatRequest() # AiChatRequest |
try:
# Chat with AI assistant
api_response = api_instance.chat(ai_chat_request)
print("The response of AIChatApi->chat:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling AIChatApi->chat: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to http://localhost:8081
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AIChatApi | chat | POST /api/v1/ai/chat | Chat with AI assistant |
| AIChatApi | delete_conversation | DELETE /api/v1/ai/conversations/{conversationId} | Delete conversation |
| AIChatApi | get_conversation_history | GET /api/v1/ai/conversations/{conversationId} | Get conversation history |
| AIChatApi | list_conversations | GET /api/v1/ai/conversations | List conversations |
| AISettingsApi | delete_settings | DELETE /api/v1/settings/ai | Reset my AI settings |
| AISettingsApi | get_settings | GET /api/v1/settings/ai | Get my AI settings |
| AISettingsApi | save_settings | PUT /api/v1/settings/ai | Save my AI settings |
| AISettingsApi | test_connection | POST /api/v1/settings/ai/test | Test AI provider connection |
| DashboardApi | get_dashboard_statistics | GET /api/v1/dashboard/statistics | Get dashboard statistics |
| FavoritesApi | add_favorite | POST /api/v1/favorites/{documentId} | Add document to favorites |
| FavoritesApi | is_favorite | GET /api/v1/favorites/{documentId}/is-favorite | Check favorite status |
| FavoritesApi | remove_favorite | DELETE /api/v1/favorites/{documentId} | Remove document from favorites |
| FavoritesApi | toggle_favorite | PUT /api/v1/favorites/{documentId}/toggle | Toggle favorite status |
| SettingsApi | get_settings1 | GET /api/v1/settings | Get user's settings |
| AuditControllerApi | get_audit_trail | GET /api/v1/audit/{id} | Get audit trail for a resource |
| AuditControllerApi | search_audit_trail | POST /api/v1/audit/search | Search for audit trails |
| AuditControllerApi | verify_chain | GET /api/v1/audit/verify | Verify audit chain integrity |
| DocumentControllerApi | create_blank_document | POST /api/v1/documents/create-blank | Create a blank document from template |
| DocumentControllerApi | delete_document_metadata | DELETE /api/v1/documents/{documentId}/metadata | Delete specific metadata keys |
| DocumentControllerApi | download_document | GET /api/v1/documents/{documentId}/download | Download a document |
| DocumentControllerApi | download_for_only_office | GET /api/v1/documents/{documentId}/onlyoffice-download | Download document for OnlyOffice |
| DocumentControllerApi | download_multiple_documents_as_zip | POST /api/v1/documents/download-multiple | Download multiple documents as ZIP |
| DocumentControllerApi | get_document_ancestors | GET /api/v1/documents/{documentId}/ancestors | Get document ancestors |
| DocumentControllerApi | get_document_info | GET /api/v1/documents/{documentId}/info | Get information of a document |
| DocumentControllerApi | get_document_metadata | POST /api/v1/documents/{documentId}/search/metadata | Search metadata of a document |
| DocumentControllerApi | get_document_position | GET /api/v1/documents/{documentId}/position | Get document position in folder |
| DocumentControllerApi | replace_document_content | PUT /api/v1/documents/{documentId}/replace-content | Replace document content |
| DocumentControllerApi | replace_document_metadata | PUT /api/v1/documents/{documentId}/replace-metadata | Replace document metadata |
| DocumentControllerApi | search_document_ids_by_metadata | POST /api/v1/documents/search/ids-by-metadata | Search document IDs by metadata |
| DocumentControllerApi | update_document_metadata | PATCH /api/v1/documents/{documentId}/metadata | Update document metadata |
| DocumentControllerApi | upload_document | POST /api/v1/documents/upload-multiple | Upload multiple documents |
| DocumentControllerApi | upload_document1 | POST /api/v1/documents/upload | Upload a single document |
| DocumentSuggestionControllerApi | get_suggestions | GET /api/v1/suggestions | |
| DocumentVersionControllerApi | download_version | GET /api/v1/documents/{documentId}/versions/{versionId}/download | Download a specific document version |
| DocumentVersionControllerApi | list_versions | GET /api/v1/documents/{documentId}/versions | List document versions |
| DocumentVersionControllerApi | restore_version | POST /api/v1/documents/{documentId}/versions/{versionId}/restore | Restore a previous document version |
| FileControllerApi | copy_files | POST /api/v1/files/copy | Copy files |
| FileControllerApi | delete_files | DELETE /api/v1/files | Delete files |
| FileControllerApi | move_files | POST /api/v1/files/move | Move files |
| FileControllerApi | rename_file | PUT /api/v1/files/{fileId}/rename | Rename a file |
| FolderControllerApi | copy_folders | POST /api/v1/folders/copy | Copy folders |
| FolderControllerApi | 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 | POST /api/v1/folders | Create a new folder |
| FolderControllerApi | delete_folders | DELETE /api/v1/folders | Delete folders |
| FolderControllerApi | list_folder | GET /api/v1/folders/list | List files and subfolders contained in a given folder |
| FolderControllerApi | move_folders | POST /api/v1/folders/move | Move folders |
| FolderControllerApi | rename_folder | PUT /api/v1/folders/{folderId}/rename | Rename a folder |
| TusControllerApi | cancel_upload | DELETE /api/v1/tus/{uploadId} | Cancel upload |
| TusControllerApi | create_upload | POST /api/v1/tus | Create new TUS upload |
| TusControllerApi | finalize_upload | POST /api/v1/tus/{uploadId}/finalize | Finalize upload |
| TusControllerApi | get_config | GET /api/v1/tus/config | Get TUS configuration |
| TusControllerApi | get_upload_info | GET /api/v1/tus/{uploadId}/info | Get upload information |
| TusControllerApi | get_upload_offset | HEAD /api/v1/tus/{uploadId} | Get upload progress |
| TusControllerApi | is_upload_complete | GET /api/v1/tus/{uploadId}/complete | Check upload completion |
| TusControllerApi | options | OPTIONS /api/v1/tus | TUS capability discovery |
| TusControllerApi | upload_chunk | PATCH /api/v1/tus/{uploadId} | Upload chunk |
Documentation For Models
- AiChatConversation
- AiChatRequest
- AiChatResponse
- AiConnectionTestResult
- AiSettingsResponse
- AncestorInfo
- AuditLog
- AuditLogDetails
- AuditLogDetailsOneOf
- AuditVerificationResult
- BrokenLink
- CopyAudit
- CopyRequest
- CopyResponse
- CreateBlankDocumentRequest
- CreateFolderAudit
- CreateFolderRequest
- DashboardStatisticsResponse
- DeleteAudit
- DeleteMetadataAudit
- DeleteMetadataRequest
- DeleteRequest
- DocumentInfo
- DocumentPosition
- DocumentVersionInfo
- ElementInfo
- FileTypeStats
- FilterInput
- FolderElementInfo
- FolderResponse
- MoveAudit
- MoveRequest
- RenameAudit
- RenameRequest
- ReplaceAudit
- RestoreVersionAudit
- RestoreVersionResponse
- SaveAiSettingsRequest
- SearchByAuditLogRequest
- SearchByMetadataRequest
- SearchMetadataRequest
- Settings
- SortInput
- StorageBreakdown
- Suggest
- TusConfigResponse
- TusFinalizeRequest
- TusUploadInfo
- UpdateMetadataAudit
- UpdateMetadataRequest
- UploadAudit
- UploadResponse
Documentation For Authorization
Authentication schemes defined for the API:
keycloak_auth
- Type: Bearer authentication (JWT)
Author
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
openfilz_sdk-1.2.25.tar.gz
(72.3 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
openfilz_sdk-1.2.25-py3-none-any.whl
(132.7 kB
view details)
File details
Details for the file openfilz_sdk-1.2.25.tar.gz.
File metadata
- Download URL: openfilz_sdk-1.2.25.tar.gz
- Upload date:
- Size: 72.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.14.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3f056a989da74e6395d365f2b7168ad926837501db0d63e7b98085f44aaf6c02
|
|
| MD5 |
0e012e3d76bbb21aa0194126a3cab984
|
|
| BLAKE2b-256 |
a8e1d6024674468b0e5da176fa8ee7225471a45ed634f7cbfcb8284594c51e20
|
File details
Details for the file openfilz_sdk-1.2.25-py3-none-any.whl.
File metadata
- Download URL: openfilz_sdk-1.2.25-py3-none-any.whl
- Upload date:
- Size: 132.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.14.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
703ceee4c2b344586106535d1609fc92616629cfa34f736f14a6ac0a7663e71b
|
|
| MD5 |
03a46c3f6e915d732057b0395c3bebf6
|
|
| BLAKE2b-256 |
8ca3d1989748fb4f3ef8d6433e5603cb1b297ea3e27fc483599a8206b7f43c3a
|
