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] = field(default_factory=dict)

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] = field(default_factory=dict)

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

ZohoSignTriggersInput dataclass

ZohoSignTriggersInput(webhook_url: Optional[str] = None, webhook_actions: Optional[str] = None, purpose: Optional[str] = None, appname: Optional[str] = None)

Zoho Sign Triggers

Attributes

webhook_url class-attribute instance-attribute

webhook_url: Optional[str] = None

Webhook url

webhook_actions class-attribute instance-attribute

webhook_actions: Optional[str] = None

Webhook actions

purpose class-attribute instance-attribute

purpose: Optional[str] = None

Purpose

appname class-attribute instance-attribute

appname: Optional[str] = None

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] = None

code

document_form_data class-attribute instance-attribute

document_form_data: Optional[Dict[str, Any]] = None

Document form data

status class-attribute instance-attribute

status: Optional[str] = None

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] = None

code

requests class-attribute instance-attribute

requests: Optional[Dict[str, Any]] = None

requests

message class-attribute instance-attribute

message: Optional[str] = None

message

status class-attribute instance-attribute

status: Optional[str] = None

status

UpdateDocumentInput dataclass

UpdateDocumentInput(requests: Optional[Dict[str, Any]] = None)

Update the properties of a created request

Attributes

requests class-attribute instance-attribute

requests: Optional[Dict[str, Any]] = None

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] = None

code

message class-attribute instance-attribute

message: Optional[str] = None

message

status class-attribute instance-attribute

status: Optional[str] = None

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] = None

code

message class-attribute instance-attribute

message: Optional[str] = None

message

status class-attribute instance-attribute

status: Optional[str] = None

status

GetTemplatesResponse dataclass

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

Response for Get list of templates

ZohosignClient

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

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
token_provider	Optional[TokenProvider]	Optional token provider. Defaults to ManagedIdentityTokenProvider.	None
options	Optional[ConnectorClientOptions]	Optional connector client options.	None

Methods:

invoke_api_async async

invoke_api_async(input: InvokeAPIInput, url: str, method: str) -> dict[str, Any] | None

Invoke API

Invoke API

download_completion_certificate_async async

download_completion_certificate_async(request_id: int) -> bytes

Download Completion Certificate

Downloads the completion certificate of a specific envelope

download_document_async async

download_document_async(request_id: int) -> bytes

Download Document

Downloads a specific envelope

download_file_async async

download_file_async(request_id: int, document_id: int) -> bytes

Download File

Downloads a specific document or file

get_form_data_async async

get_form_data_async(request_id: int) -> dict[str, Any] | None

Get data of completed request

Shows the details of a signed envelope

recall_document_async async

recall_document_async(request_id: int) -> None

Recall a particular document

Recall a particular document

remind_document_recipients_async async

remind_document_recipients_async(request_id: int) -> None

Reminder for recipients

Send a reminder to recipients of a particular document.

delete_document_async async

delete_document_async(request_id: int) -> None

Delete Document

Delete a particular document

get_document_async async

get_document_async(request_id: int) -> dict[str, Any] | None

Get a document

Shows the details of a specific envelope

update_document_async async

update_document_async(input: UpdateDocumentInput, request_id: str) -> dict[str, Any] | None

Update the properties of a created request

Update the properties of a created request

send_sign_request_async async

send_sign_request_async(request_id: str) -> dict[str, Any] | None

SendSignRequest

Send the uploaded document out for signature

get_template_details_async async

get_template_details_async(template_id: str) -> None

Get particular template details

Shows the details of a specific document template

get_templates_async async

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

Get list of templates

Shows a list of all the document templates created