Metadata-Version: 2.4
Name: openfilz_sdk
Version: 1.1.15
Summary: openfilz-api
Home-page: 
Author: OpenAPI Generator community
Author-email: OpenAPI Generator Community <team@openapitools.org>
License: Apache 2.0
Project-URL: Repository, https://github.com/GIT_USER_ID/GIT_REPO_ID
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
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.1.15
- Generator version: 7.20.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python 3.9+

## 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/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.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.DashboardApi(api_client)

    try:
        # Get dashboard statistics
        api_response = api_instance.get_dashboard_statistics()
        print("The response of DashboardApi->get_dashboard_statistics:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DashboardApi->get_dashboard_statistics: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *http://localhost:8081*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DashboardApi* | [**get_dashboard_statistics**](docs/DashboardApi.md#get_dashboard_statistics) | **GET** /api/v1/dashboard/statistics | Get dashboard statistics
*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
*SettingsApi* | [**get_settings**](docs/SettingsApi.md#get_settings) | **GET** /api/v1/settings | Get user&#39;s settings
*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 | 
*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
*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

 - [AncestorInfo](docs/AncestorInfo.md)
 - [AuditLog](docs/AuditLog.md)
 - [AuditLogDetails](docs/AuditLogDetails.md)
 - [AuditLogDetailsOneOf](docs/AuditLogDetailsOneOf.md)
 - [AuditVerificationResult](docs/AuditVerificationResult.md)
 - [BrokenLink](docs/BrokenLink.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)
 - [DashboardStatisticsResponse](docs/DashboardStatisticsResponse.md)
 - [DeleteAudit](docs/DeleteAudit.md)
 - [DeleteMetadataAudit](docs/DeleteMetadataAudit.md)
 - [DeleteMetadataRequest](docs/DeleteMetadataRequest.md)
 - [DeleteRequest](docs/DeleteRequest.md)
 - [DocumentInfo](docs/DocumentInfo.md)
 - [DocumentPosition](docs/DocumentPosition.md)
 - [ElementInfo](docs/ElementInfo.md)
 - [FileTypeStats](docs/FileTypeStats.md)
 - [FilterInput](docs/FilterInput.md)
 - [FolderElementInfo](docs/FolderElementInfo.md)
 - [FolderResponse](docs/FolderResponse.md)
 - [MoveAudit](docs/MoveAudit.md)
 - [MoveRequest](docs/MoveRequest.md)
 - [RenameAudit](docs/RenameAudit.md)
 - [RenameRequest](docs/RenameRequest.md)
 - [ReplaceAudit](docs/ReplaceAudit.md)
 - [SearchByAuditLogRequest](docs/SearchByAuditLogRequest.md)
 - [SearchByMetadataRequest](docs/SearchByMetadataRequest.md)
 - [SearchMetadataRequest](docs/SearchMetadataRequest.md)
 - [Settings](docs/Settings.md)
 - [SortInput](docs/SortInput.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)


<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




