iparapheur-internal
iparapheur v5.x main core application.
The main link between every sub-services, integrating business code logic.
This Python package is automatically generated by the OpenAPI Generator project:
- API version: DEVELOP
- Package version: 0.0.20260624215652
- Generator version: 7.22.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://libriciel.fr
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/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:
import iparapheur_internal
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 iparapheur_internal
Tests
Execute pytest to run the tests.
Getting Started
Please follow the installation procedure and then run the following:
import iparapheur_internal
from iparapheur_internal.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = iparapheur_internal.Configuration(
host = "http://localhost"
)
# 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.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Enter a context with an instance of the API client
with iparapheur_internal.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = iparapheur_internal.AdminAdvancedConfigApi(api_client)
try:
# Delete signature validation service configuration
api_instance.delete_signature_validation_service_configuration()
except ApiException as e:
print("Exception when calling AdminAdvancedConfigApi->delete_signature_validation_service_configuration: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to http://localhost
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AdminAdvancedConfigApi | delete_signature_validation_service_configuration | DELETE /api/internal/admin/server-info/signature-validation-service | Delete signature validation service configuration |
| AdminAdvancedConfigApi | get_signature_validation_service_configuration | GET /api/internal/admin/server-info/signature-validation-service | Get signature validation service configuration |
| AdminAdvancedConfigApi | update_gdpr_information_details | PUT /api/internal/admin/server-info/gdpr | Register GDPR information details |
| AdminAdvancedConfigApi | update_signature_validation_service_configuration | PUT /api/internal/admin/server-info/signature-validation-service | Edit signature validation service configuration |
| AdminAllUsersApi | count_logged_in_users | GET /api/internal/admin/user/count | Count logged in users |
| AdminDeskApi | list_desks_by_user | GET /api/internal/admin/tenant/{tenantId}/desks-by-user | List desks by user |
| AdminDeskApi | list_hierarchic_desks | GET /api/internal/admin/tenant/{tenantId}/desk | List desks |
| AdminExternalSignatureApi | test_external_signature_config | POST /api/internal/admin/tenant/{tenantId}/external-signature-config/test | Test an external signature config |
| AdminFolderApi | list_folders_as_admin | POST /api/internal/admin/tenant/{tenantId}/folder | List folders |
| AdminFolderApi | list_folders_as_admin_legacy | GET /api/internal/admin/tenant/{tenantId}/folder/legacy-list | Legacy method for Listing folders from <= 5.1 versions |
| AdminFolderApi | transfer_as_admin | PUT /api/internal/admin/tenant/{tenantId}/folder/{folderId}/task/{taskId}/transfer | Transfer as admin |
| AdminLayerApi | create_file_stamp | POST /api/internal/admin/tenant/{tenantId}/layer/{layerId}/stamp | Create a file stamp |
| AdminLayerApi | create_layer | POST /api/internal/admin/tenant/{tenantId}/layer | Create a layer |
| AdminLayerApi | delete_file_stamp | DELETE /api/internal/admin/tenant/{tenantId}/layer/{layerId}/stamp/{stampId} | Delete a stored image stamp |
| AdminLayerApi | delete_layer | DELETE /api/internal/admin/tenant/{tenantId}/layer/{layerId} | Delete layer |
| AdminLayerApi | get_layer | GET /api/internal/admin/tenant/{tenantId}/layer/{layerId} | Get a layer with every information set |
| AdminLayerApi | get_layer_example_pdf | POST /api/internal/admin/tenant/{tenantId}/layer/example-pdf | Test the given layer on a blank PDF |
| AdminLayerApi | get_stamp_image | GET /api/internal/admin/tenant/{tenantId}/layer/{layerId}/stamp/{stampId}/image | get the image of a file stamp |
| AdminLayerApi | list_layers | GET /api/internal/admin/tenant/{tenantId}/layer | List layers |
| AdminLayerApi | update_layer | PUT /api/internal/admin/tenant/{tenantId}/layer/{layerId} | Edit a layer |
| AdminMonitoringApi | get_all_jobs_data | GET /api/internal/admin/monitoring/jobs | Get all jobs data |
| AdminMonitoringApi | get_job_data | GET /api/internal/admin/monitoring/job/{job}/data | Get a job data |
| AdminMonitoringApi | get_local_space_usage | GET /api/internal/admin/monitoring/local-space-usage | Get a job data |
| AdminSealCertificateApi | get_seal_signature_image | GET /api/internal/admin/tenant/{tenantId}/sealCertificate/{sealCertificateId}/signatureImage | Get seal's signature image |
| AdminSealCertificateApi | list_subtype_usage | GET /api/internal/admin/tenant/{tenantId}/sealCertificate/{sealCertificateId}/subtypeUsage | List subtypes using the given certificate |
| AdminSecureMailApi | list_entities | POST /api/internal/admin/tenant/{tenantId}/secure-mail-server/entities | Get server entities |
| AdminSecureMailApi | test_server | POST /api/internal/admin/tenant/{tenantId}/secure-mail-server/test | Test server configuration |
| AdminTemplateApi | test_docket_pdf_template | POST /api/internal/admin/tenant/{tenantId}/test-docket-pdf-template | Test the given docket PDF template |
| AdminTemplateApi | test_mail_template | POST /api/internal/admin/tenant/{tenantId}/test-mail-template | Test the given mail template |
| AdminTemplateApi | test_signature_pdf_template | POST /api/internal/admin/tenant/{tenantId}/test-signature-pdf-template | Get the server default signature template |
| AdminTrashBinApi | list_trash_bin_listable_folders | GET /api/internal/admin/tenant/{tenantId}/trash-bin | List folders in the trash-bin |
| AdminTypologyApi | get_typology_hierarchy | GET /api/internal/admin/tenant/{tenantId}/typology | Get typology list, sorted by hierarchy. |
| AdminWorkflowDefinitionApi | get_subtypes_referencing_workflow_definition_key | GET /api/internal/admin/tenant/{tenantId}/workflowDefinitionByKey/{workflowDefinitionKey}/referencingSubtypes | Get subtypes referencing the given workflow definition key |
| CurrentUserApi | create_filter_v2 | POST /api/internal/current-user/user-filters | Create filter |
| CurrentUserApi | delete_filter_v2 | DELETE /api/internal/current-user/user-filters/{folderFilterId} | Delete filter |
| CurrentUserApi | delete_table_layout | DELETE /api/internal/currentUser/table-layout/{tableLayoutId} | Delete tableLayout |
| CurrentUserApi | get_administered_desks_for_tenant | GET /api/internal/currentUser/administeredDesksForTenant/{tenantId} | List desks |
| CurrentUserApi | get_administered_desks_for_tenant_by_user | GET /api/internal/currentUser/administeredDesksByUserForTenant/{tenantId} | List desks by user for functional |
| CurrentUserApi | get_current_user_filters_v2 | GET /api/internal/current-user/user-filters | Get userFilters |
| CurrentUserApi | update_current_user_password | PUT /api/internal/currentUser/password | Update user password |
| CurrentUserApi | update_filter_v2 | PUT /api/internal/current-user/user-filters/{folderFilterId} | Update filter |
| CurrentUserApi | update_table_layout | PUT /api/internal/currentUser/table-layout/{tableLayoutName} | Update tableLayout |
| DeskApi | create_delegation | POST /api/internal/tenant/{tenantId}/desk/{deskId}/delegation | Create a new delegation (active or planned) from target desk |
| DeskApi | delete_delegation | DELETE /api/internal/tenant/{tenantId}/desk/{deskId}/delegation/{delegationId} | Remove an active or planned delegation from target Desk |
| DeskApi | get_associated_desks | GET /api/internal/tenant/{tenantId}/desk/{deskId}/associatedDesks | Get the target desk's associated ones |
| DeskApi | get_associated_desks_by_user | GET /api/internal/tenant/{tenantId}/desk/{deskId}/associated-desks-by-user | Get the target desk's associated ones by user |
| DeskApi | list_delegations | GET /api/internal/tenant/{tenantId}/desk/{deskId}/delegation | List delegations (active and planned) for the given delegating desk |
| DeskApi | update_delegation | PUT /api/internal/admin/tenant/{tenantId}/desk/{deskId}/delegation/{delegationId} | Update a delegation from target Desk |
| DocumentApi | create_annotation | POST /api/internal/tenant/{tenantId}/folder/{folderId}/document/{documentId}/annotations | Creates a PDF annotation |
| DocumentApi | create_signature_placement_annotation | POST /api/internal/tenant/{tenantId}/folder/{folderId}/document/{documentId}/signaturePlacement | Creates a signature placement annotation |
| DocumentApi | delete_annotation | DELETE /api/internal/tenant/{tenantId}/folder/{folderId}/document/{documentId}/annotations/{annotationId} | Deletes the given PDF annotation |
| DocumentApi | generate_visualization_pdf | PUT /api/internal/tenant/{tenantId}/folder/{folderId}/document/{documentId}/visualization-pdf | Generate the visualization PDF. Only applicable to non-PDF documents. |
| DocumentApi | get_next_signature_position | GET /api/internal/tenant/{tenantId}/folder/{folderId}/action/{action}/document/{documentId}/signaturePosition | Get next signature position of a document |
| DocumentApi | get_signature_placement_annotations | GET /api/internal/tenant/{tenantId}/folder/{folderId}/document/{documentId}/signaturePlacement | Get all signaturePlacement Annotations of a document |
| FolderApi | generate_document_signature_verification | POST /api/internal/tenant/{tenantId}/folder/{folderId}/signature-report | Get the document(s) signature validation report |
| FolderApi | get_folder_by_legacy_id | GET /api/internal/tenant/{tenantId}/folder/by-legacy-id/{legacyId} | Get the current folder and its data, from a 'legacyId' (an id set at creation time) |
| FolderApi | list_folder_with_columns | POST /api/internal/tenant/{tenantId}/desk/{deskId}/folder/{state} | |
| FolderApi | list_folder_with_columns_v2 | POST /api/internal/tenant/{tenantId}/desk/{deskId}/folder/{state}/v2 | |
| FolderApi | list_folders | POST /api/internal/tenant/{tenantId}/desk/{deskId}/search/{state} | Query folders |
| FolderApi | print_folder | GET /api/internal/tenant/{tenantId}/folder/{folderId}/print | Get the PDF printable version of a folder |
| FolderApi | send_folder_by_mail | POST /api/internal/tenant/{tenantId}/folder/{folderId}/mail | Send given folder by mail |
| FolderApi | update_folder | PUT /api/internal/tenant/{tenantId}/folder/{folderId} | Edit folder parameters |
| SecureMailApi | get_secure_mail_status | GET /api/internal/tenant/{tenantId}/folder/{folderId}/task/{taskId}/secure-mail | Get the current state |
| ServerInfoApi | get_server_info | GET /api/internal/server-info | Get server information: GDPR definition, password rules and signature validation service activation status |
| TemplateApi | test_signature_template | POST /api/internal/tenant/{tenantId}/templates/{templateType}/example | Test the tenant signature template |
| TenantApi | get_tenant | GET /api/internal/tenant/{tenantId} | Get a tenant with every information set |
| TenantApi | list_tenants_for_user | GET /api/internal/tenant | List tenants attached with the current user |
| TypologyApi | get_subtype | GET /api/internal/tenant/{tenantId}/typology/type/{typeId}/subtype/{subtypeId} | Get a subtype |
| TypologyApi | get_type | GET /api/internal/tenant/{tenantId}/typology/type/{typeId} | Get a type with every informations set |
| WorkflowApi | evaluate_workflow_selection_script | POST /api/internal/tenant/{tenantId}/desk/{deskId}/evaluate-workflow-selection-script | Returns the evaluated workflow definition, using current parent desks, and given metadata on a possible selection script |
| WorkflowApi | get_workflow_definition | GET /api/internal/tenant/{tenantId}/desk/{deskId}/workflow-definition/{workflowDefinitionKey} | Get a workflow definition with every information set |
| WorkflowApi | paper_signature | PUT /api/internal/tenant/{tenantId}/desk/{deskId}/folder/{folderId}/task/{taskId}/paper_signature | Paper signature |
Documentation For Models
- Action
- ColumnedTaskListRequest
- ColumnedTaskListRequestV2
- CompositeId
- CreateFileStampRequest
- CreateFolderRequest
- DateFilterDto
- DelegationDto
- DelegationSortBy
- DeskRepresentation
- DetachedSignatureDto
- DocumentDto
- DocumentType
- ErrorResponse
- ExternalSignatureConfig
- ExternalSignatureConfigDto
- ExternalSignatureConfigRepresentation
- ExternalSignatureLevel
- ExternalSignatureProvider
- ExternalState
- FolderDto
- FolderFilterDto
- FolderFilterV2Dto
- FolderListableDto
- FolderSortBy
- FolderVisibility
- GdprApplication
- GdprCookie
- GdprDataElement
- GdprDataSet
- GdprDeclaringEntity
- GdprDeclaringEntityDpo
- GdprDeclaringEntityResponsible
- GdprEntity
- GdprInformationDetailsDto
- HierarchisedDeskRepresentation
- JobDataResponse
- LabelledColumn
- LabelledColumnType
- LayerDto
- LayerRepresentation
- MailParams
- MailTemplateTestRequest
- MediaType
- Metadata
- MetadataDto
- MetadataFilterDto
- MetadataRepresentation
- MetadataType
- PageDelegationDto
- PageDeskRepresentation
- PageFolderDto
- PageFolderListableDto
- PageHierarchisedDeskRepresentation
- PageInfo
- PageLayerRepresentation
- PageSubtypeRepresentation
- PageTenantRepresentation
- PageTypologyRepresentation
- PageableObject
- PasswordPolicies
- PasswordResetRequest
- PdfSignaturePosition
- PdfSignaturePositionDto
- PdfTemplateTestRequest
- SealCertificateRepresentation
- SecureMailDocument
- SecureMailDocumentMailInfo
- SecureMailEntity
- SecureMailServerDto
- ServerInfoDto
- SignatureFormat
- SignaturePlacement
- SignatureProofDto
- SignatureProtocol
- SimpleTaskParams
- SortObject
- StampDto
- StampTextColor
- StampType
- State
- StepDefinitionDto
- StepDefinitionParallelType
- StepDefinitionType
- StickyNote
- Subtype
- SubtypeDto
- SubtypeLayer
- SubtypeLayerAssociation
- SubtypeLayerDto
- SubtypeMetadata
- SubtypeMetadataDto
- SubtypeRepresentation
- TableLayoutDto
- TableName
- Task
- TemplateInfo
- TemplateType
- TenantDto
- TenantRepresentation
- TestSignatureTemplateRequest
- TransferTaskParams
- TypeDto
- TypeRepresentation
- TypologyRepresentation
- UserPrivilege
- UserRepresentation
- ValidatedSignatureInformationDto
- ValidationServiceConfigurationDto
- WorkflowDefinitionDto
Documentation For Authorization
Authentication schemes defined for the API:
spring_oauth
- Type: OAuth
- Flow: accessCode
- Authorization URL: /auth/realms/api/protocol/openid-connect/auth
- Scopes: N/A
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
File details
Details for the file iparapheur_internal-0.0.20260624215652.tar.gz.
File metadata
- Download URL: iparapheur_internal-0.0.20260624215652.tar.gz
- Upload date:
- Size: 123.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.14.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
811194380f7f876e7094da5b188219c0e246894c989e88ed88808632339b73ba
|
|
| MD5 |
97f51ef7a0c1b1586a987a1ee286d458
|
|
| BLAKE2b-256 |
76c1176c24fdea8bd3039426e03d1ee8e7587d742fd741088f5c763672933ad5
|
