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.4.4
• 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)
    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

Documentation For Models

• AiChatConversation
• AiChatRequest
• AiChatResponse
• AiConnectionTestResult
• AiModelsResponse
• AiPreferencesView
• AiSettingsResponse
• AncestorInfo
• ApplySignatureRequest
• AuditIntegrityStatusResponse
• AuditLog
• AuditLogDetails
• AuditLogDetailsOneOf
• AuditVerificationResult
• AutoFileInboxRequest
• AutoFileJobView
• AutoFileJobsRequest
• AutoFileRequest
• AutoFileTicket
• BrokenLink
• CancelInstanceRequest
• CloudSignatureSubscription
• CompleteTaskRequest
• CopyAudit
• CopyRequest
• CopyResponse
• CreateBlankDocumentRequest
• CreateFolderAudit
• CreateFolderRequest
• CreateSignatureEnvelopeRequest
• DashboardStatisticsResponse
• DeclineSignatureRequest
• DeleteAudit
• DeleteMetadataAudit
• DeleteMetadataRequest
• DeleteRequest
• DocumentInfo
• DocumentInsightView
• DocumentIntegrityRecord
• DocumentPosition
• DocumentVersionInfo
• ElementInfo
• EmbeddingBackfillRequest
• EmbeddingBackfillStatus
• ErrorResponse
• Facet
• FileTypeStats
• FilingOutcome
• FilterInput
• FolderElementInfo
• FolderResponse
• InsightBackfillRequest
• InsightBackfillStatus
• InsightCategoryUpdate
• InsightFacets
• InstantiateTemplateRequest
• Item
• ItemResult
• ListAiModelsRequest
• MergeRequest
• MergeSource
• MetadataKeySuggestion
• MoveAudit
• MoveRequest
• MyStorageQuota
• MyTasksCountDTO
• OrganizeRequest
• OutputTarget
• PageInstruction
• PdfInfo
• PdfOperationResponse
• PdfOutlineEntry
• PdfOutputInfo
• PdfPageInfo
• PdfTransformAudit
• PerDefinition
• PublicSignatureView
• QuotaOverview
• QuotaUsage
• QuotaUserPage
• ReassignTaskRequest
• RenameAudit
• RenameRequest
• ReorganizationApplyRequest
• ReorganizationApplyResult
• ReorganizationByKindRequest
• ReorganizationPlanView
• ReplaceAudit
• RestoreVersionAudit
• RestoreVersionResponse
• RoleBinding
• RotateRequest
• SaveAiPreferencesRequest
• SaveAiSettingsRequest
• SaveWorkflowDefinitionRequest
• SearchByAuditLogRequest
• SearchByMetadataRequest
• SearchMetadataRequest
• Settings
• SignatureEnvelopeDTO
• SignatureEventDTO
• SignatureFieldDTO
• SignatureFieldInput
• SignatureFieldPlacement
• SignatureFieldValue
• SignatureRecipientDTO
• SignatureRecipientInput
• SignatureTemplateDTO
• SignatureTemplateField
• SignatureTemplateRequest
• SignatureTemplateRole
• SortInput
• SplitOutput
• SplitRequest
• StartWorkflowRequest
• StorageBreakdown
• Suggest
• TusConfigResponse
• TusFinalizeRequest
• TusUploadInfo
• UnzipRequest
• UnzipResponse
• UnzipSkippedEntry
• UpdateMetadataAudit
• UpdateMetadataRequest
• UploadAudit
• UploadResponse
• UserQuotaRequest
• VerifyOtpRequest
• Vote
• WorkflowAction
• WorkflowActionFailureAudit
• WorkflowAssignment
• WorkflowAudit
• WorkflowDefinitionDTO
• WorkflowEventDTO
• WorkflowInstanceDTO
• WorkflowInstanceDetailDTO
• WorkflowInstancePage
• WorkflowProblem
• WorkflowReview
• WorkflowReviewProgressDTO
• WorkflowSpec
• WorkflowState
• WorkflowSummaryDTO
• WorkflowTaskDTO
• WorkflowTransition
• WorkflowValidationResult

Documentation For Authorization

Authentication schemes defined for the API:

keycloak_auth

• Type: Bearer authentication (JWT)

Author