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.32
  • 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 list_models POST /api/v1/settings/ai/models List the provider's chat models
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
ESignApi cancel POST /api/v1/signatures/{id}/cancel Cancel a non-terminal envelope
ESignApi cloud_subscription 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 get1 GET /api/v1/signatures/{id} Get one of my envelopes (recipients + fields)
ESignApi list_sent GET /api/v1/signatures List envelopes I sent for signature
ESignApi list_to_sign 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 signed_document GET /api/v1/signatures/{id}/signed-document Download the sealed PDF of a completed envelope
ESignTemplatesApi create1 POST /api/v1/signature-templates Create a template
ESignTemplatesApi delete DELETE /api/v1/signature-templates/{id} Delete 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
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 mark_viewed POST /api/v1/public/signatures/viewed Record that the recipient opened the document
ESignPublicApi request_otp 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 verify_otp 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
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

Documentation For Authorization

Authentication schemes defined for the API:

keycloak_auth

  • Type: Bearer authentication (JWT)

Author

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (1.3.18)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for openfilz from gravatar.com openfilz

Credits

Author: OpenAPI Generator community

License

AGPL-3.0

Requires

Python >=3.9

Tags

OpenAPI OpenAPI-Generator openfilz-api

Report project as malware

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.32.tar.gz (95.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

openfilz_sdk-1.2.32-py3-none-any.whl (180.2 kB view details)

Uploaded Python 3

File details

Details for the file openfilz_sdk-1.2.32.tar.gz.

File metadata

  • Download URL: openfilz_sdk-1.2.32.tar.gz
  • Upload date:
  • Size: 95.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.14.7

File hashes

Hashes for openfilz_sdk-1.2.32.tar.gz
Algorithm Hash digest
SHA256 30a665b21361043dff1b6c1e6179e8c710f3774ffcc414fad7727c9a46e9ef2d
MD5 2ebd0d97f06929268b36a5a3e2d5fd76
BLAKE2b-256 dd38266747149067fca25c378d22c327cc2bf00078f47649f4cd9f4dcee2b5e7

See more details on using hashes here.

File details

Details for the file openfilz_sdk-1.2.32-py3-none-any.whl.

File metadata

  • Download URL: openfilz_sdk-1.2.32-py3-none-any.whl
  • Upload date:
  • Size: 180.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.14.7

File hashes

Hashes for openfilz_sdk-1.2.32-py3-none-any.whl
Algorithm Hash digest
SHA256 802517b826984735f0877a4ff64e3d428771ecbd0a9855bce1dc1f3d2b706cf4
MD5 48706acfb7302e8248ce3b6698a8dd9e
BLAKE2b-256 0ccca5b7184e766ad6f744068c4abbe74e1e33a14119b75fd9afd5f42bdf8414

See more details on using hashes here.

Release history Release notifications | RSS feed

1.3.18

2 files

1.3.17

2 files

1.3.16

2 files

1.3.15

2 files

1.3.14

2 files

1.3.13

2 files

1.3.12

2 files

1.3.10

2 files

1.3.9

2 files

1.3.8

2 files

1.3.7

2 files

1.3.6

2 files

1.3.5

2 files

1.3.4

2 files

1.3.3

2 files

1.3.2

2 files

1.3.1

2 files

1.3.0

2 files

1.2.41

2 files

1.2.40

2 files

1.2.39

2 files

1.2.38

2 files

1.2.37

2 files

1.2.36

2 files

1.2.35

2 files

1.2.34

2 files

1.2.33

2 files

This release

1.2.32 This release

2 files

1.2.31

2 files

1.2.30

2 files

1.2.29

2 files

1.2.28

2 files

1.2.27

2 files

1.2.26

2 files

1.2.25

2 files

1.2.24

2 files

1.2.23

2 files

1.2.22

2 files

1.2.21

2 files

1.2.20

2 files

1.2.19

2 files

1.2.18

2 files

1.2.17

2 files

1.2.16

2 files

1.2.15

2 files

1.2.14

2 files

1.2.11

2 files

1.2.10

2 files

1.2.9

2 files

1.2.8

2 files

1.2.7

2 files

1.2.6

2 files

1.2.4

2 files

1.2.3

2 files

1.2.2

2 files

1.2.1

2 files

1.2.0

2 files

1.1.26

2 files

1.1.25

2 files

1.1.24

2 files

1.1.23

2 files

1.1.22

2 files

1.1.21

2 files

1.1.20

2 files

1.1.19

2 files

1.1.18

2 files

1.1.17

2 files

1.1.16

2 files

1.1.15

2 files

1.1.14

2 files

1.1.13

2 files

1.1.12

2 files

1.1.11

2 files

1.1.10

2 files

1.1.9

2 files

1.1.8

2 files

1.1.7

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page