DocuwareClient

Attributes

UpdateIndexFieldsInput module-attribute

UpdateIndexFieldsInput = List[Dict[str, Any]]

Classes

SearchForDocumentsInFileCabinetInput dataclass

SearchForDocumentsInFileCabinetInput(additional_properties: Dict[str, Any] = dict())

Search in file cabinet

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

SearchForDocumentsInFileCabinetResponse dataclass

SearchForDocumentsInFileCabinetResponse(count: Optional[int] = None, documents: Optional[List[Dict[str, Any]]] = None)

Response for Search in file cabinet

Attributes

count class-attribute instance-attribute

count: Optional[int] = field(default=None, metadata={'wire_name': 'Count'})

Count

documents class-attribute instance-attribute

documents: Optional[List[Dict[str, Any]]] = field(default=None, metadata={'wire_name': 'Documents'})

Documents

GetOrganizationResponse dataclass

GetOrganizationResponse(name: Optional[str] = None)

Response for Get organization

Attributes

name class-attribute instance-attribute

name: Optional[str] = field(default=None, metadata={'wire_name': 'Name'})

Name

GetFileCabinetsResponse dataclass

GetFileCabinetsResponse(file_cabinets: Optional[List[Dict[str, Any]]] = None)

Response for Get file cabinets and document trays

Attributes

file_cabinets class-attribute instance-attribute

file_cabinets: Optional[List[Dict[str, Any]]] = field(default=None, metadata={'wire_name': 'FileCabinets'})

FileCabinets

GetDocumentInformationResponse dataclass

GetDocumentInformationResponse(sections: Optional[List[Dict[str, Any]]] = None, document_id: Optional[int] = None, index_fields: Optional[Dict[str, Any]] = None, document_title: Optional[str] = None, file_cabinet_id: Optional[str] = None, total_pages: Optional[int] = None, file_size: Optional[int] = None, content_type: Optional[str] = None, version_status: Optional[str] = None, document_flags: Optional[Dict[str, Any]] = None)

Response for Get document information

Attributes

sections class-attribute instance-attribute

sections: Optional[List[Dict[str, Any]]] = field(default=None, metadata={'wire_name': 'Sections'})

Sections

document_id class-attribute instance-attribute

document_id: Optional[int] = field(default=None, metadata={'wire_name': 'DocumentId'})

DocumentId

index_fields class-attribute instance-attribute

index_fields: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'IndexFields'})

IndexFields

document_title class-attribute instance-attribute

document_title: Optional[str] = field(default=None, metadata={'wire_name': 'DocumentTitle'})

DocumentTitle

file_cabinet_id class-attribute instance-attribute

file_cabinet_id: Optional[str] = field(default=None, metadata={'wire_name': 'FileCabinetId'})

FileCabinetId

total_pages class-attribute instance-attribute

total_pages: Optional[int] = field(default=None, metadata={'wire_name': 'TotalPages'})

TotalPages

file_size class-attribute instance-attribute

file_size: Optional[int] = field(default=None, metadata={'wire_name': 'FileSize'})

FileSize

content_type class-attribute instance-attribute

content_type: Optional[str] = field(default=None, metadata={'wire_name': 'ContentType'})

ContentType

version_status class-attribute instance-attribute

version_status: Optional[str] = field(default=None, metadata={'wire_name': 'VersionStatus'})

VersionStatus

document_flags class-attribute instance-attribute

document_flags: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'DocumentFlags'})

DocumentFlags

UpdateIndexFieldsResponse dataclass

UpdateIndexFieldsResponse(sections: Optional[List[Dict[str, Any]]] = None, document_id: Optional[int] = None, index_fields: Optional[Dict[str, Any]] = None, document_title: Optional[str] = None, file_cabinet_id: Optional[str] = None, total_pages: Optional[int] = None, file_size: Optional[int] = None, content_type: Optional[str] = None, version_status: Optional[str] = None, document_flags: Optional[Dict[str, Any]] = None)

Response for Update index fields

Attributes

sections class-attribute instance-attribute

sections: Optional[List[Dict[str, Any]]] = field(default=None, metadata={'wire_name': 'Sections'})

Sections

document_id class-attribute instance-attribute

document_id: Optional[int] = field(default=None, metadata={'wire_name': 'DocumentId'})

DocumentId

index_fields class-attribute instance-attribute

index_fields: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'IndexFields'})

IndexFields

document_title class-attribute instance-attribute

document_title: Optional[str] = field(default=None, metadata={'wire_name': 'DocumentTitle'})

DocumentTitle

file_cabinet_id class-attribute instance-attribute

file_cabinet_id: Optional[str] = field(default=None, metadata={'wire_name': 'FileCabinetId'})

FileCabinetId

total_pages class-attribute instance-attribute

total_pages: Optional[int] = field(default=None, metadata={'wire_name': 'TotalPages'})

TotalPages

file_size class-attribute instance-attribute

file_size: Optional[int] = field(default=None, metadata={'wire_name': 'FileSize'})

FileSize

content_type class-attribute instance-attribute

content_type: Optional[str] = field(default=None, metadata={'wire_name': 'ContentType'})

ContentType

version_status class-attribute instance-attribute

version_status: Optional[str] = field(default=None, metadata={'wire_name': 'VersionStatus'})

VersionStatus

document_flags class-attribute instance-attribute

document_flags: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'DocumentFlags'})

DocumentFlags

TransferDocumentInput dataclass

TransferDocumentInput(source_file_cabinet_id: Optional[str] = None, documents: Optional[List[Dict[str, Any]]] = None, keep_source: Optional[bool] = None, fill_intellix: Optional[bool] = None)

Transfer documents

Attributes

source_file_cabinet_id class-attribute instance-attribute

source_file_cabinet_id: Optional[str] = field(default=None, metadata={'wire_name': 'SourceFileCabinetId'})

Select the source File Cabinet or Document Tray.

keep_source class-attribute instance-attribute

keep_source: Optional[bool] = field(default=None, metadata={'wire_name': 'KeepSource'})

Choose whether the source documents should be deleted or not.

fill_intellix class-attribute instance-attribute

fill_intellix: Optional[bool] = field(default=None, metadata={'wire_name': 'FillIntellix'})

Choose whether intelligent indexing should be used when storing.

TransferDocumentResponse dataclass

TransferDocumentResponse(count: Optional[int] = None, documents: Optional[List[Dict[str, Any]]] = None)

Response for Transfer documents

Attributes

count class-attribute instance-attribute

count: Optional[int] = field(default=None, metadata={'wire_name': 'Count'})

Count

documents class-attribute instance-attribute

documents: Optional[List[Dict[str, Any]]] = field(default=None, metadata={'wire_name': 'Documents'})

Documents

PlaceAStampInput dataclass

PlaceAStampInput(file_number: Optional[int] = None, page_number: Optional[int] = None, layer: Optional[int] = None, position_x: Optional[float] = None, position_y: Optional[float] = None, stamp_id: Optional[str] = None, password: Optional[str] = None, fields: Optional[List[Dict[str, Any]]] = None)

Place a stamp

Attributes

file_number class-attribute instance-attribute

file_number: Optional[int] = field(default=None, metadata={'wire_name': 'FileNumber'})

Specify the file/section containing the page to be stamped.

page_number class-attribute instance-attribute

page_number: Optional[int] = field(default=None, metadata={'wire_name': 'PageNumber'})

Specify the page number to place the stamp on.

layer class-attribute instance-attribute

layer: Optional[int] = field(default=None, metadata={'wire_name': 'Layer'})

Specify the document layer to place the stamp on [1-5]

position_x class-attribute instance-attribute

position_x: Optional[float] = field(default=None, metadata={'wire_name': 'PositionX'})

[Optional] Position from the left edge of the page in mm.

position_y class-attribute instance-attribute

position_y: Optional[float] = field(default=None, metadata={'wire_name': 'PositionY'})

[Optional] Position from the upper edge of the page in mm.

stamp_id class-attribute instance-attribute

stamp_id: Optional[str] = field(default=None, metadata={'wire_name': 'StampId'})

Select or specify the stamp to be used.

password class-attribute instance-attribute

password: Optional[str] = field(default=None, metadata={'wire_name': 'Password'})

Specify the password for the stamp (if required).

PlaceAStampResponse dataclass

PlaceAStampResponse(created: Optional[Dict[str, Any]] = None, type_: Optional[str] = None, color: Optional[str] = None, rotation: Optional[int] = None, transparent: Optional[bool] = None, stroke_width: Optional[int] = None, guid: Optional[str] = None)

Response for Place a stamp

Attributes

created class-attribute instance-attribute

created: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'Created'})

Created

type_ class-attribute instance-attribute

type_: Optional[str] = field(default=None, metadata={'wire_name': 'Type'})

Type

color class-attribute instance-attribute

color: Optional[str] = field(default=None, metadata={'wire_name': 'Color'})

Color

rotation class-attribute instance-attribute

rotation: Optional[int] = field(default=None, metadata={'wire_name': 'Rotation'})

Rotation

transparent class-attribute instance-attribute

transparent: Optional[bool] = field(default=None, metadata={'wire_name': 'Transparent'})

Transparent

stroke_width class-attribute instance-attribute

stroke_width: Optional[int] = field(default=None, metadata={'wire_name': 'StrokeWidth'})

StrokeWidth

guid class-attribute instance-attribute

guid: Optional[str] = field(default=None, metadata={'wire_name': 'Guid'})

Guid

GetDialogsResponse dataclass

GetDialogsResponse(dialogs: Optional[List[Dict[str, Any]]] = None)

Response for Get dialogs

Attributes

dialogs class-attribute instance-attribute

dialogs: Optional[List[Dict[str, Any]]] = field(default=None, metadata={'wire_name': 'Dialogs'})

Dialogs

GetStampsResponse dataclass

GetStampsResponse(stamps: Optional[List[Dict[str, Any]]] = None)

Response for Get stamps

Attributes

stamps class-attribute instance-attribute

stamps: Optional[List[Dict[str, Any]]] = field(default=None, metadata={'wire_name': 'Stamps'})

Stamps

GetStampFieldsResponse dataclass

GetStampFieldsResponse(fields: Optional[List[Dict[str, Any]]] = None)

Response for Get stamp fields

Attributes

fields class-attribute instance-attribute

fields: Optional[List[Dict[str, Any]]] = field(default=None, metadata={'wire_name': 'Fields'})

Fields

GetFileCabinetFieldsResponse dataclass

GetFileCabinetFieldsResponse(fields: Optional[List[Dict[str, Any]]] = None)

Response for Get file cabinet fields

Attributes

fields class-attribute instance-attribute

fields: Optional[List[Dict[str, Any]]] = field(default=None, metadata={'wire_name': 'Fields'})

Fields

GetDialogFieldsResponse dataclass

GetDialogFieldsResponse(fields: Optional[List[Dict[str, Any]]] = None)

Response for Get dialog fields

Attributes

fields class-attribute instance-attribute

fields: Optional[List[Dict[str, Any]]] = field(default=None, metadata={'wire_name': 'Fields'})

Fields

ListDocumentsInDocumentTrayResponse dataclass

ListDocumentsInDocumentTrayResponse(count: Optional[int] = None, documents: Optional[List[Dict[str, Any]]] = None)

Response for List documents in document tray

Attributes

count class-attribute instance-attribute

count: Optional[int] = field(default=None, metadata={'wire_name': 'Count'})

Count

DocuwareClient

DocuwareClient(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)

Bases: ConnectorClientBase

Typed client for docuware connector.

Initialize a DocuwareClient.

Parameters:

Name	Type	Description	Default
connection_runtime_url	str	The connection runtime URL from Azure Portal.	required
token_provider	Optional[TokenProvider]	Optional token provider. Defaults to ManagedIdentityTokenProvider.	None
options	Optional[ConnectorClientOptions]	Optional connector client options.	None

Methods:

search_for_documents_in_file_cabinet_async async

search_for_documents_in_file_cabinet_async(input: SearchForDocumentsInFileCabinetInput, file_cabinet: str, search_dialog_id: str) -> dict[str, Any] | None

Search in file cabinet

Search a file cabinet for documents matching the specified criteria.

get_organization_async async

get_organization_async() -> dict[str, Any] | None

Get organization

Get the organization name.

get_file_cabinets_async async

get_file_cabinets_async(file_cabinet_type: str) -> dict[str, Any] | None

Get file cabinets and document trays

Gets a list of file cabinets and/or document trays.

get_document_information_async async

get_document_information_async(file_cabinet_id: str, document_id: int) -> dict[str, Any] | None

Get document information

Gets information about a document.

delete_document_async async

delete_document_async(file_cabinet_id: str, document_id: int) -> None

Delete a document

Deletes a document from a file cabinet or document tray.

download_file_async async

download_file_async(file_cabinet_id: str, document_id: int, file_number: str, document_format: str) -> bytes

Download a file

Downloads a file/section of a document stored in a file cabinet or document tray.

download_document_async async

download_document_async(file_cabinet_id: str, document_id: int, document_format: str) -> bytes

Download a document

Downloads a document from a file cabinet or document tray.

update_index_fields_async async

update_index_fields_async(input: UpdateIndexFieldsInput, file_cabinet_id: str, document_id: int) -> dict[str, Any] | None

Update index fields

Updates the index fields of a document.

transfer_document_async async

transfer_document_async(input: TransferDocumentInput, destination_file_cabinet_id: str, store_dialog_id: Optional[str] = None) -> dict[str, Any] | None

Transfer documents

Moves one or more documents from one file cabinet/document tray to another.

place_a_stamp_async async

place_a_stamp_async(input: PlaceAStampInput, file_cabinet_id: str, document_id: int) -> dict[str, Any] | None

Place a stamp

Places a stamp on a document.

get_dialogs_async async

get_dialogs_async(file_cabinet: str, dialog_type: Optional[str] = None) -> dict[str, Any] | None

Get dialogs

Gets a list of dialogs for a file cabinet or document tray.

get_stamps_async async

get_stamps_async(file_cabinet: str) -> dict[str, Any] | None

Get stamps

Gets a list of stamps for a file cabinet or document tray.

get_stamp_fields_async async

get_stamp_fields_async(file_cabinet: str, stamp: str) -> dict[str, Any] | None

Get stamp fields

Gets a list of fields for a stamp.

get_file_cabinet_fields_async async

get_file_cabinet_fields_async(file_cabinet: str, field_type: Optional[str] = None) -> dict[str, Any] | None

Get file cabinet fields

Gets a list of fields for a file cabinet.

get_dialog_fields_async async

get_dialog_fields_async(file_cabinet: str, dialog_id: str) -> dict[str, Any] | None

Get dialog fields

Gets the fields for a dialog

list_documents_in_document_tray_async async

list_documents_in_document_tray_async(document_tray: str) -> dict[str, Any] | None

List documents in document tray

List documents from the specified document tray.