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] = dataclass_field(default_factory=dict, kw_only=True)

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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Count'})

Count

documents class-attribute instance-attribute

documents: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, 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]]] = dataclass_field(default=None, kw_only=True, 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]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Sections'})

Sections

document_id class-attribute instance-attribute

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

DocumentId

index_fields class-attribute instance-attribute

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

IndexFields

document_title class-attribute instance-attribute

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

DocumentTitle

file_cabinet_id class-attribute instance-attribute

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

FileCabinetId

total_pages class-attribute instance-attribute

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

TotalPages

file_size class-attribute instance-attribute

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

FileSize

content_type class-attribute instance-attribute

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

ContentType

version_status class-attribute instance-attribute

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

VersionStatus

document_flags class-attribute instance-attribute

document_flags: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, 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]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Sections'})

Sections

document_id class-attribute instance-attribute

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

DocumentId

index_fields class-attribute instance-attribute

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

IndexFields

document_title class-attribute instance-attribute

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

DocumentTitle

file_cabinet_id class-attribute instance-attribute

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

FileCabinetId

total_pages class-attribute instance-attribute

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

TotalPages

file_size class-attribute instance-attribute

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

FileSize

content_type class-attribute instance-attribute

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

ContentType

version_status class-attribute instance-attribute

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

VersionStatus

document_flags class-attribute instance-attribute

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

DocumentFlags

TransferDocumentInput dataclass

TransferDocumentInput(source_file_cabinet_id: str, *, 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: str = dataclass_field(metadata={'wire_name': 'SourceFileCabinetId'})

Select the source File Cabinet or Document Tray.

keep_source class-attribute instance-attribute

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

Choose whether the source documents should be deleted or not.

fill_intellix class-attribute instance-attribute

fill_intellix: Optional[bool] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Count'})

Count

documents class-attribute instance-attribute

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

Documents

PlaceAStampInput dataclass

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

Place a stamp

Attributes

file_number class-attribute instance-attribute

file_number: int = dataclass_field(metadata={'wire_name': 'FileNumber'})

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

page_number class-attribute instance-attribute

page_number: int = dataclass_field(metadata={'wire_name': 'PageNumber'})

Specify the page number to place the stamp on.

layer class-attribute instance-attribute

layer: int = dataclass_field(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] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PositionY'})

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

stamp_id class-attribute instance-attribute

stamp_id: str = dataclass_field(metadata={'wire_name': 'StampId'})

Select or specify the stamp to be used.

password class-attribute instance-attribute

password: Optional[str] = dataclass_field(default=None, kw_only=True, 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]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Created'})

Created

type_ class-attribute instance-attribute

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

Type

color class-attribute instance-attribute

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

Color

rotation class-attribute instance-attribute

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

Rotation

transparent class-attribute instance-attribute

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

Transparent

stroke_width class-attribute instance-attribute

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

StrokeWidth

guid class-attribute instance-attribute

guid: Optional[str] = dataclass_field(default=None, kw_only=True, 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]]] = dataclass_field(default=None, kw_only=True, 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]]] = dataclass_field(default=None, kw_only=True, 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]]] = dataclass_field(default=None, kw_only=True, 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]]] = dataclass_field(default=None, kw_only=True, 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]]] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Count'})

Count

DocuwareClient

DocuwareClient(connection_runtime_url: str, credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, retry_jitter_factor: float = 0.1, retry_unsafe_http_methods: bool = False, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any)

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
credential	AsyncTokenCredential | AzureKeyCredential	Caller-owned Azure Core credential.	required
max_retry_attempts	int	The maximum number of request attempts.	3
timeout	float	The network timeout in seconds for each request. The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines.	30.0
use_exponential_backoff	bool	Whether retries use exponential backoff.	True
initial_retry_delay_seconds	float	The initial retry delay in seconds.	0.5
maximum_retry_delay_seconds	float	The maximum retry delay in seconds.	120.0
retry_jitter_factor	float	The jitter fraction applied to retry delays.	0.1
retry_unsafe_http_methods	bool	Whether unsafe HTTP methods may be retried.	False
transport	Optional[AsyncHttpTransport]	Optional Azure Core async HTTP transport closed by the client through its asynchronous lifecycle.	None
**kwargs	Any	Optional Azure Core pipeline policy settings.	{}

Methods:

search_for_documents_in_file_cabinet async

search_for_documents_in_file_cabinet(input: SearchForDocumentsInFileCabinetInput | Mapping[str, Any], file_cabinet: str, search_dialog_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Search in file cabinet

Search a file cabinet for documents matching the specified criteria.

Swagger operation ID: SearchForDocumentsInFileCabinet.

Parameters:

Name	Type	Description	Default
input	SearchForDocumentsInFileCabinetInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
file_cabinet	str	Select the File Cabinet to search.	required
search_dialog_id	str	Select the search dialog to use for searching.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_organization async

get_organization(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get organization

Get the organization name.

Swagger operation ID: GetOrganization.

Parameters:

Name	Type	Description	Default
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_file_cabinets

list_file_cabinets(file_cabinet_type: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get file cabinets and document trays

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

Returns a single-page Azure Core async collection.

Swagger operation ID: GetFileCabinets.

Parameters:

Name	Type	Description	Default
file_cabinet_type	str	Select which types you want returned.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_document_information async

get_document_information(file_cabinet_id: str, document_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get document information

Gets information about a document.

Swagger operation ID: GetDocumentInformation.

Parameters:

Name	Type	Description	Default
file_cabinet_id	str	Select the File Cabinet or Document Tray with your document.	required
document_id	int	Specify the ID of the document you want information on.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

delete_document async

delete_document(file_cabinet_id: str, document_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Delete a document

Deletes a document from a file cabinet or document tray.

Swagger operation ID: DeleteDocument.

Parameters:

Name	Type	Description	Default
file_cabinet_id	str	Select the File Cabinet or Document Tray with your document.	required
document_id	int	Specify the ID of the document you want to delete.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

download_file async

download_file(file_cabinet_id: str, document_id: int, file_number: str, document_format: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

Download a file

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

Swagger operation ID: DownloadFile.

Parameters:

Name	Type	Description	Default
file_cabinet_id	str	Select the File Cabinet or Document Tray with your document.	required
document_id	int	Specify the ID of the document with the file you want to download.	required
file_number	str	Specify the file number of the file you want to download.	required
document_format	str	Select the format for the downloaded document.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
bytes	bytes	The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

download_document async

download_document(file_cabinet_id: str, document_id: int, document_format: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

Download a document

Downloads a document from a file cabinet or document tray.

Swagger operation ID: DownloadDocument.

Parameters:

Name	Type	Description	Default
file_cabinet_id	str	Select the File Cabinet or Document Tray with your document.	required
document_id	int	Specify the ID of the document you want to download.	required
document_format	str	Select the format for the downloaded document.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
bytes	bytes	The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

update_index_fields async

update_index_fields(input: UpdateIndexFieldsInput, file_cabinet_id: str, document_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Update index fields

Updates the index fields of a document.

Swagger operation ID: UpdateIndexFields.

Parameters:

Name	Type	Description	Default
input	UpdateIndexFieldsInput	The request body.	required
file_cabinet_id	str	Select the File Cabinet with the document to update.	required
document_id	int	Specify the ID of the document to update.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

transfer_document async

transfer_document(input: TransferDocumentInput | Mapping[str, Any], destination_file_cabinet_id: str, *, store_dialog_id: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Transfer documents

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

Swagger operation ID: TransferDocument.

Parameters:

Name	Type	Description	Default
input	TransferDocumentInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
destination_file_cabinet_id	str	Select the destination File Cabinet or Document Tray.	required
store_dialog_id	Optional[str]	Select the store dialog for indexing the documents being moved.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

place_a_stamp async

place_a_stamp(input: PlaceAStampInput | Mapping[str, Any], file_cabinet_id: str, document_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Place a stamp

Places a stamp on a document.

Swagger operation ID: PlaceAStamp.

Parameters:

Name	Type	Description	Default
input	PlaceAStampInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
file_cabinet_id	str	Select the File Cabinet or Document Tray with your document.	required
document_id	int	Specify the ID of the document you want to stamp.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_dialogs

list_dialogs(file_cabinet: str, *, dialog_type: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get dialogs

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

Returns a single-page Azure Core async collection.

Swagger operation ID: GetDialogs.

Parameters:

Name	Type	Description	Default
file_cabinet	str	Select the File Cabinet or Document Tray to get dialogs from.	required
dialog_type	Optional[str]	Select the type of dialogs to return.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_stamps

list_stamps(file_cabinet: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get stamps

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

Returns a single-page Azure Core async collection.

Swagger operation ID: GetStamps.

Parameters:

Name	Type	Description	Default
file_cabinet	str	Select the File Cabinet or Document Tray to get stamps from.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_stamp_fields

list_stamp_fields(file_cabinet: str, stamp: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get stamp fields

Gets a list of fields for a stamp.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetStampFields.

Parameters:

Name	Type	Description	Default
file_cabinet	str	Select the File Cabinet or Document Tray with the desired stamp.	required
stamp	str	Select the stamp to get its fields.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_file_cabinet_fields

list_file_cabinet_fields(file_cabinet: str, *, field_type: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get file cabinet fields

Gets a list of fields for a file cabinet.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetFileCabinetFields.

Parameters:

Name	Type	Description	Default
file_cabinet	str	Select the File Cabinet to get fields for.	required
field_type	Optional[str]	Select the type of fields to return.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_dialog_fields

list_dialog_fields(file_cabinet: str, dialog_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get dialog fields

Gets the fields for a dialog

Returns a single-page Azure Core async collection.

Swagger operation ID: GetDialogFields.

Parameters:

Name	Type	Description	Default
file_cabinet	str	Select the File Cabinet.	required
dialog_id	str	Select the dialog to get the fields for.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_documents_in_document_tray

list_documents_in_document_tray(document_tray: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List documents in document tray

List documents from the specified document tray.

Returns a single-page Azure Core async collection.

Swagger operation ID: ListDocumentsInDocumentTray.

Parameters:

Name	Type	Description	Default
document_tray	str	Select the Document Tray to search.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.