ZohosignClient

Attributes

TRIGGER_OPERATIONS module-attribute

TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'zoho-sign-triggers': {'operation_id': 'zoho-sign-triggers', 'path': '/{connectionId}/internal/accounts/webhooks', 'method': 'post', 'required_parameters': ['body'], 'callback_payload_type': None}}

Classes

InvokeAPIInput dataclass

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

Invoke API

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])

InvokeAPIResponse dataclass

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

Response for Invoke API

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])

ZohoSignTriggersInput dataclass

ZohoSignTriggersInput(webhook_url: str, webhook_actions: str, purpose: str, appname: str)

Zoho Sign Triggers

Attributes

webhook_url instance-attribute

webhook_url: str

Webhook url

webhook_actions instance-attribute

webhook_actions: str

Webhook actions

purpose instance-attribute

purpose: str

Purpose

appname instance-attribute

appname: str

appname

GetFormDataResponse dataclass

GetFormDataResponse(*, code: Optional[int] = None, document_form_data: Optional[Dict[str, Any]] = None, status: Optional[str] = None)

Response for Get data of completed request

Attributes

code class-attribute instance-attribute

code: Optional[int] = dataclass_field(default=None, kw_only=True)

code

document_form_data class-attribute instance-attribute

document_form_data: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

Document form data

status class-attribute instance-attribute

status: Optional[str] = dataclass_field(default=None, kw_only=True)

status

GetDocumentResponse dataclass

GetDocumentResponse(*, code: Optional[int] = None, requests: Optional[Dict[str, Any]] = None, message: Optional[str] = None, status: Optional[str] = None)

Response for Get a document

Attributes

code class-attribute instance-attribute

code: Optional[int] = dataclass_field(default=None, kw_only=True)

code

requests class-attribute instance-attribute

requests: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

requests

message class-attribute instance-attribute

message: Optional[str] = dataclass_field(default=None, kw_only=True)

message

status class-attribute instance-attribute

status: Optional[str] = dataclass_field(default=None, kw_only=True)

status

UpdateDocumentInput dataclass

UpdateDocumentInput(requests: Dict[str, Any])

Update the properties of a created request

Attributes

requests instance-attribute

requests: Dict[str, Any]

requests

UpdateDocumentResponse dataclass

UpdateDocumentResponse(*, code: Optional[int] = None, message: Optional[str] = None, status: Optional[str] = None)

Response for Update the properties of a created request

Attributes

code class-attribute instance-attribute

code: Optional[int] = dataclass_field(default=None, kw_only=True)

code

message class-attribute instance-attribute

message: Optional[str] = dataclass_field(default=None, kw_only=True)

message

status class-attribute instance-attribute

status: Optional[str] = dataclass_field(default=None, kw_only=True)

status

SendSignRequestResponse dataclass

SendSignRequestResponse(*, code: Optional[int] = None, message: Optional[str] = None, status: Optional[str] = None)

Response for SendSignRequest

Attributes

code class-attribute instance-attribute

code: Optional[int] = dataclass_field(default=None, kw_only=True)

code

message class-attribute instance-attribute

message: Optional[str] = dataclass_field(default=None, kw_only=True)

message

status class-attribute instance-attribute

status: Optional[str] = dataclass_field(default=None, kw_only=True)

status

GetTemplatesResponse dataclass

GetTemplatesResponse(*, templates: Optional[List[Dict[str, Any]]] = None)

Response for Get list of templates

ZohosignClient

ZohosignClient(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 zohosign connector.

Initialize a ZohosignClient.

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:

invoke_api async

invoke_api(input: InvokeAPIInput | Mapping[str, Any], url: str, method: 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

Invoke API

Invoke API

Swagger operation ID: InvokeAPI.

Parameters:

Name	Type	Description	Default
input	InvokeAPIInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
url	str	Provide url path.	required
method	str	Select API Method to be used.	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.

download_completion_certificate async

download_completion_certificate(request_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

Download Completion Certificate

Downloads the completion certificate of a specific envelope

Swagger operation ID: download-completion-certificate.

Parameters:

Name	Type	Description	Default
request_id	int	Request ID.	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(request_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

Download Document

Downloads a specific envelope

Swagger operation ID: download-document.

Parameters:

Name	Type	Description	Default
request_id	int	Request ID.	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_file async

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

Download File

Downloads a specific document or file

Swagger operation ID: download-file.

Parameters:

Name	Type	Description	Default
request_id	int	Request ID.	required
document_id	int	Document ID.	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.

get_form_data async

get_form_data(request_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 data of completed request

Shows the details of a signed envelope

Swagger operation ID: get-form-data.

Parameters:

Name	Type	Description	Default
request_id	int	Request id.	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.

recall_document async

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

Recall a particular document

Recall a particular document

Swagger operation ID: recall-document.

Parameters:

Name	Type	Description	Default
request_id	int	Request ID.	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.

remind_document_recipients async

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

Reminder for recipients

Send a reminder to recipients of a particular document.

Swagger operation ID: remind-document-recipients.

Parameters:

Name	Type	Description	Default
request_id	int	Request ID.	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.

delete_document async

delete_document(request_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 Document

Delete a particular document

Swagger operation ID: delete-document.

Parameters:

Name	Type	Description	Default
request_id	int	Request ID.	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.

get_document async

get_document(request_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 a document

Shows the details of a specific envelope

Swagger operation ID: get-document.

Parameters:

Name	Type	Description	Default
request_id	int	Request ID.	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.

update_document async

update_document(input: UpdateDocumentInput | Mapping[str, Any], request_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

Update the properties of a created request

Update the properties of a created request

Swagger operation ID: UpdateDocument.

Parameters:

Name	Type	Description	Default
input	UpdateDocumentInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
request_id	str	Request ID.	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.

send_sign_request async

send_sign_request(request_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

SendSignRequest

Send the uploaded document out for signature

Swagger operation ID: SendSignRequest.

Parameters:

Name	Type	Description	Default
request_id	str	Request ID.	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_template_details async

get_template_details(template_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Get particular template details

Shows the details of a specific document template

Swagger operation ID: get-template-details.

Parameters:

Name	Type	Description	Default
template_id	str	List of Templates.	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.

list_templates

list_templates(*, 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 list of templates

Shows a list of all the document templates created

Returns a single-page Azure Core async collection.

Swagger operation ID: GetTemplates.

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
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.