openfilz-ee-sdk 1.4.1.dev0

openfilz-api

openfilz-ee-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.4.1.dev0
• 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:

pip install git+https://github.com/openfilz/openfilz-ee.git

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

Then import the package:

import openfilz_ee_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_ee_sdk

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import openfilz_ee_sdk
from openfilz_ee_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_ee_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_ee_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with openfilz_ee_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openfilz_ee_sdk.CommentsApi(api_client)
    create_comment_request = openfilz_ee_sdk.CreateCommentRequest() # CreateCommentRequest | 

    try:
        # Create a comment
        api_response = api_instance.create_comment(create_comment_request)
        print("The response of CommentsApi->create_comment:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling CommentsApi->create_comment: %s\n" % e)

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
CommentsApi	create_comment	POST /api/v1/documents/comments	Create a comment
CommentsApi	delete_comment	DELETE /api/v1/documents/comments/{id}	Delete a comment
CommentsApi	update_comment	PUT /api/v1/documents/comments/{id}	Update a comment
DashboardApi	get_dashboard_statistics	GET /api/v1/dashboard/statistics	Get dashboard statistics
DelegatedBrowseGrantsAdminApi	browse_folders	GET /api/v1/admin/delegated/folders	Browse folders on behalf of the grantor
DelegatedBrowseGrantsAdminApi	consume	POST /api/v1/admin/delegated/grants/{id}/consume	Mark grant as consumed
DelegatedBrowseGrantsAdminApi	get_grant	GET /api/v1/admin/delegated/grants/{id}	Poll grant status
DelegatedBrowseGrantsAdminApi	list_mine	GET /api/v1/admin/delegated/grants	List grants I requested
DelegatedBrowseGrantsAdminApi	request_grant	POST /api/v1/admin/delegated/grants	Request a grant
DelegatedBrowseGrantsEndUserApi	accept	POST /api/v1/users/me/delegated/grants/{id}/accept	Approve a pending grant
DelegatedBrowseGrantsEndUserApi	decline	POST /api/v1/users/me/delegated/grants/{id}/decline	Refuse a pending grant
DelegatedBrowseGrantsEndUserApi	disable_linked_webhook	POST /api/v1/users/me/delegated/grants/{id}/disable-webhook	Disable the webhook created from this grant
DelegatedBrowseGrantsEndUserApi	list_incoming	GET /api/v1/users/me/delegated/grants	List grants addressed to me
DelegatedBrowseGrantsEndUserApi	revoke	POST /api/v1/users/me/delegated/grants/{id}/revoke	Revoke an accepted grant
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
NotificationsApi	get_notifications	GET /api/v1/notifications	Get all notifications
NotificationsApi	get_unread_count	GET /api/v1/notifications/unread/count	Get unread notification count
NotificationsApi	mark_all_as_read	PUT /api/v1/notifications/read-all	Mark all notifications as read
NotificationsApi	mark_as_read	PUT /api/v1/notifications/{id}/read	Mark notification as read
NotificationsApi	stream_notifications	GET /api/v1/notifications/stream	Subscribe to notification stream
ScanAgentApi	download	GET /api/v1/agent/download/{platform}	Download agent binary
ScanAgentApi	get_version	GET /api/v1/agent/version	Get agent version
ScannerProxyApi	get_ingestion_status	GET /api/v1/scan/status	Get ingestion status
ScannerProxyApi	get_scan_job_status	GET /api/v1/scan/scanners/{id}/scan/{jobId}/status	Get scan job status
ScannerProxyApi	get_scanner_capabilities	GET /api/v1/scan/scanners/{id}/capabilities	Get scanner capabilities
ScannerProxyApi	list_scanners	GET /api/v1/scan/scanners	List scanners
ScannerProxyApi	trigger_scan	POST /api/v1/scan/scanners/{id}/scan	Trigger scan
SearchAdministrationApi	create_index	POST /api/v1/admin/search	Create search index
SearchAdministrationApi	delete_index	DELETE /api/v1/admin/search	Delete search index
SearchAdministrationApi	get_status	GET /api/v1/admin/search/status	Get reindexation status
SearchAdministrationApi	reindex_all	POST /api/v1/admin/search/reindex	Reindex all documents
SettingsApi	get_settings	GET /api/v1/settings	Get user's settings
SettingsApi	save_settings	PUT /api/v1/settings	Save user preferences
UserPrivacyApi	get	GET /api/v1/users/me/privacy	Read my privacy preferences
UserPrivacyApi	update	PUT /api/v1/users/me/privacy	Update my privacy preferences
CollaborationAuditControllerApi	get_audit_trail	GET /api/v1/audit/{id}	Get audit trail for a resource (enriched with actor azp)
CollaborationAuditControllerApi	search_audit_trail	POST /api/v1/audit/search	Search audit trail (enriched with actor azp)
CollaborationAuditControllerApi	verify_chain	GET /api/v1/audit/verify	Verify audit chain integrity
CollaborationControllerApi	accept_share_request	POST /api/v1/users/share-requests/{id}/accept	Accept a share request
CollaborationControllerApi	add_team_members	POST /api/v1/users/teams/{teamId}/members	Add team members
CollaborationControllerApi	create_shared_documents	POST /api/v1/users/share	Create Share for document(s)
CollaborationControllerApi	create_team	POST /api/v1/users/teams	Create a team
CollaborationControllerApi	create_user	POST /api/v1/users	Create a new user
CollaborationControllerApi	deactivate_user	DELETE /api/v1/users/{userId}	Deactivate a user
CollaborationControllerApi	delete_shared_documents	DELETE /api/v1/users/share	Delete Share for document(s)
CollaborationControllerApi	delete_team	DELETE /api/v1/users/teams/{teamId}	Delete a team
CollaborationControllerApi	get_team_members	GET /api/v1/users/teams/{teamId}/members	Get team members
CollaborationControllerApi	get_user_status	GET /api/v1/users/me/status	Check user status
CollaborationControllerApi	reject_share_request	DELETE /api/v1/users/share-requests/{id}	Reject a share request
CollaborationControllerApi	remove_team_members	DELETE /api/v1/users/teams/{teamId}/members	Remove team members
CollaborationControllerApi	update_shared_documents	PUT /api/v1/users/share	Update Share for document(s)
CollaborationControllerApi	update_team	PUT /api/v1/users/teams/{teamId}	Update a team
CollaborationControllerApi	update_user	PUT /api/v1/users/{userId}	Update a user
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
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
UploadTokenControllerApi	mint_upload_token	POST /api/v1/upload-tokens	Mint a scoped upload token
UploadTokenControllerApi	upload_with_token	POST /api/v1/upload-tokens/upload	Upload a single document with a scoped upload token
WebhookProxyControllerApi	proxy	GET /api/v1/webhooks/**
WebhookProxyControllerApi	proxy1	POST /api/v1/webhooks/**
WebhookProxyControllerApi	proxy2	PUT /api/v1/webhooks/**
WebhookProxyControllerApi	proxy3	DELETE /api/v1/webhooks/**
WebhookProxyControllerApi	proxy4	PATCH /api/v1/webhooks/**
WebhookProxyControllerApi	proxy5	HEAD /api/v1/webhooks/**
WebhookProxyControllerApi	proxy6	OPTIONS /api/v1/webhooks/**

Documentation For Models

• AncestorInfo
• AuditLogDetails
• AuditVerificationResult
• BrokenLink
• CommentDTO
• ConsumeDelegatedGrantRequest
• CopyAudit
• CopyRequest
• CopyResponse
• CreateBlankDocumentRequest
• CreateCommentRequest
• CreateDelegatedGrantRequest
• CreateFolderAudit
• CreateFolderRequest
• CreateTeamRequest
• DashboardStatisticsResponse
• DelegatedFolderNode
• DelegatedGrantDTO
• DeleteAudit
• DeleteMetadataAudit
• DeleteMetadataRequest
• DeleteRequest
• DeleteShareRequest
• DocumentInfo
• DocumentPosition
• ElementInfo
• EnrichedAuditLog
• EnrichedAuditLogDetails
• FileTypeStats
• FilterInput
• FolderElementInfo
• FolderResponse
• IngestionStatusDto
• MintUploadTokenRequest
• MoveAudit
• MoveRequest
• NotificationDTO
• RenameAudit
• RenameRequest
• ReplaceAudit
• ScanJobStatusDto
• ScanRequestDto
• ScannerInfoDto
• SearchByAuditLogRequest
• SearchByMetadataRequest
• SearchMetadataRequest
• Settings
• ShareRequest
• ShareResultError
• ShareResultItem
• ShareResultResponse
• SortInput
• StorageBreakdown
• Suggest
• TeamMemberInfo
• TusConfigResponse
• TusFinalizeRequest
• TusUploadInfo
• UpdateCommentRequest
• UpdateMetadataAudit
• UpdateMetadataRequest
• UpdateTeamRequest
• UpdateUserPrivacyRequest
• UpdateUserRequest
• UploadAudit
• UploadResponse
• UploadTokenResponse
• UserPreferencesRequest
• UserPrivacyDTO
• UserRegistrationRequest

Documentation For Authorization

Authentication schemes defined for the API:

keycloak_auth

• Type: Bearer authentication (JWT)

Author