DocusignClient

Attributes

UpdateDocgenFormFieldsInput module-attribute

UpdateDocgenFormFieldsInput = List[Dict[str, Any]]

UpdateEnvelopePrefillTabsInput module-attribute

UpdateEnvelopePrefillTabsInput = List[Dict[str, Any]]

UpdateRecipientTabsValuesInput module-attribute

UpdateRecipientTabsValuesInput = List[Dict[str, Any]]

GetDocumentsResponse module-attribute

GetDocumentsResponse = str

TRIGGER_OPERATIONS module-attribute

TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'CreateOrgHookEnvelope': {'operation_id': 'CreateOrgHookEnvelope', 'path': '/{connectionId}/Management/v2/organizations/{organizationId}/connect', 'method': 'post', 'required_parameters': ['organizationId', 'body'], 'callback_payload_type': 'CreateOrgHookEnvelopeResponse'}, 'CreateHookEnvelopeV4': {'operation_id': 'CreateHookEnvelopeV4', 'path': '/{connectionId}/accounts/{accountId}/connectV4', 'method': 'post', 'required_parameters': ['accountId', 'body'], 'callback_payload_type': 'CreateHookEnvelopeResponse'}}

Classes

CreateOrgHookEnvelopeInput dataclass

CreateOrgHookEnvelopeInput(all_users: str, allow_envelope_publish: str, include_document_fields: str, requires_acknowledgement: str, url_to_publish_to: str, name: str, events: List[str])

When a Docusign Connect event occurs (Organization-level)

Attributes

name instance-attribute

name: str

Name your Connect configuration (for example, "Envelope Events").

events instance-attribute

events: List[str]

Select an event. To include another event, select "Add new item."

CreateOrgHookEnvelopeResponse dataclass

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

Response for When a Docusign Connect event occurs (Organization-level)

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

DocGenFormFieldsResponse dataclass

DocGenFormFieldsResponse(*, docgen_fields: Optional[List[DocGenFormField | Mapping[str, Any]]] = None)

Response for Get document generation form fields from envelope

Attributes

docgen_fields class-attribute instance-attribute

docgen_fields: Optional[List[DocGenFormField | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'docgenFields'})

Docgen Fields

GetDocGenTemplateTabsResponse dataclass

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

Response for Get document generation form fields from template (bulk send templates only)

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

EnvelopeVoidResponse dataclass

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

Response for Void the envelope

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

EnvelopeResendResponse dataclass

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

Response for Resend the envelope

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

AddRemindersResponse dataclass

AddRemindersResponse(*, reminder_enabled: Optional[str] = None)

Response for Add reminders for an envelope

Attributes

reminder_enabled class-attribute instance-attribute

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

Reminder enabled

ListTabsResponse dataclass

ListTabsResponse(*, tabs: Optional[List[Tab | Mapping[str, Any]]] = None)

Response for Get document tabs from envelope

Attributes

tabs class-attribute instance-attribute

tabs: Optional[List[Tab | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

Tabs

ListEnvelopeDocumentFieldsResponse dataclass

ListEnvelopeDocumentFieldsResponse(*, envelope_document_fields: Optional[List[EnvelopeDocumentField | Mapping[str, Any]]] = None)

Response for Get document custom fields from envelope

Attributes

envelope_document_fields class-attribute instance-attribute

envelope_document_fields: Optional[List[EnvelopeDocumentField | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'envelopeDocumentFields'})

Document Custom Fields

CompositeTemplatesResponse dataclass

CompositeTemplatesResponse(*, envelope_id: Optional[str] = None, status: Optional[str] = None, status_date_time: Optional[str] = None, uri: Optional[str] = None)

Response for Create envelope using composite templates

Attributes

envelope_id class-attribute instance-attribute

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

The id of the envelope.

status class-attribute instance-attribute

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

The status of the envelope.

status_date_time class-attribute instance-attribute

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

The datetime the status was set.

uri class-attribute instance-attribute

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

The URI for the envelope in DocuSign.

FilteredEnvelopeListResponse dataclass

FilteredEnvelopeListResponse(*, value: Optional[List[FilteredEnvelopes | Mapping[str, Any]]] = None, has_more_results: Optional[bool] = None)

Response for List envelopes

Attributes

value class-attribute instance-attribute

value: Optional[List[FilteredEnvelopes | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

Filtered envelopes

has_more_results class-attribute instance-attribute

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

Shows if envelopes exceed the specified number in the Return envelopes field

CreateEnvelopeResponse dataclass

CreateEnvelopeResponse(*, envelope_id: Optional[str] = None, template_id: Optional[str] = None, status: Optional[str] = None, status_date_time: Optional[str] = None, uri: Optional[str] = None)

Response for Create envelope using template

Attributes

envelope_id class-attribute instance-attribute

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

The id of the envelope.

template_id class-attribute instance-attribute

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

The id of the template.

status class-attribute instance-attribute

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

The status of the envelope.

status_date_time class-attribute instance-attribute

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

The datetime the status was set.

uri class-attribute instance-attribute

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

The URI for the envelope in DocuSign.

SendDraftEnvelopeResponse dataclass

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

Response for Send envelope

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

EnvelopeCustomFieldResponse dataclass

EnvelopeCustomFieldResponse(*, field_id: Optional[str] = None, field_type: Optional[str] = None, name: Optional[str] = None, value: Optional[str] = None)

Response for Get envelope custom field info

Attributes

field_id class-attribute instance-attribute

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

The id of the envelope custom field.

field_type class-attribute instance-attribute

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

The type of the envelope custom field.

name class-attribute instance-attribute

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

The name of the envelope custom field.

value class-attribute instance-attribute

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

The value of the envelope custom field.

UpdateEnvelopeCustomFieldResponse dataclass

UpdateEnvelopeCustomFieldResponse(*, field_id: Optional[str] = None, field_type: Optional[str] = None, name: Optional[str] = None, value: Optional[str] = None)

Response for Update envelope custom field

Attributes

field_id class-attribute instance-attribute

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

The id of the envelope custom field.

field_type class-attribute instance-attribute

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

The type of the envelope custom field.

name class-attribute instance-attribute

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

The name of the envelope custom field.

value class-attribute instance-attribute

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

The value of the envelope custom field.

EmbeddedSenderResponse dataclass

EmbeddedSenderResponse(*, url: Optional[str] = None)

Response for Generate Embedded Sender URL

Attributes

url class-attribute instance-attribute

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

The url of embedded sender view.

ListRecipientsResponse dataclass

ListRecipientsResponse(*, envelope_id: Optional[str] = None, signers: Optional[List[Signer | Mapping[str, Any]]] = None)

Response for List recipients from an envelope

Attributes

signers class-attribute instance-attribute

signers: Optional[List[Signer | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

Signers

Signer dataclass

Signer(*, routing_order: Optional[str] = None, role_name: Optional[str] = None, recipient_id: Optional[str] = None, name: Optional[str] = None, email: Optional[str] = None, recipient_type: Optional[str] = None, verification_type: Optional[str] = None, recipient_id_guid: Optional[str] = None)

Response for Get recipient info from envelope

Attributes

routing_order class-attribute instance-attribute

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

The signing order of the recipient in the document.

role_name class-attribute instance-attribute

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

The role of the signer.

recipient_id class-attribute instance-attribute

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

The id the recipient.

name class-attribute instance-attribute

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

The name of the recipient.

email class-attribute instance-attribute

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

The email of the recipient.

recipient_type class-attribute instance-attribute

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

The type the recipient.

verification_type class-attribute instance-attribute

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

The type of verification.

recipient_id_guid class-attribute instance-attribute

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

The recipient GUID.

AuditResponse dataclass

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

Response for Get audit event list

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

AddVerificationToRecipientResponse dataclass

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

Response for Add verification type to a recipient

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

ApplyTemplatesToDocumentsInput dataclass

ApplyTemplatesToDocumentsInput(*, document_templates: Optional[List[Dict[str, Any]]] = None)

Apply a template to documents

Attributes

document_templates class-attribute instance-attribute

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

Document Templates

CreateBulkSendListInput dataclass

CreateBulkSendListInput(*, csv: Optional[str] = None, raw_output: Optional[Dict[str, Any]] = None)

Create bulk send list

Attributes

csv class-attribute instance-attribute

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

Upload CSV File

raw_output class-attribute instance-attribute

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

Document generation fields

BulkSendListGuid dataclass

BulkSendListGuid(*, list_id: Optional[str] = None)

Response for Create bulk send list

Attributes

list_id class-attribute instance-attribute

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

Bulk send list guid

GetLoginAccountsResponse dataclass

GetLoginAccountsResponse(*, login_accounts: Optional[List[LoginAccount | Mapping[str, Any]]] = None)

Response for Login

Attributes

login_accounts class-attribute instance-attribute

login_accounts: Optional[List[LoginAccount | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'loginAccounts'})

Login accounts

ListTemplatesResponse dataclass

ListTemplatesResponse(*, envelope_templates: Optional[List[EnvelopeTemplate | Mapping[str, Any]]] = None)

Response for List templates

Attributes

envelope_templates class-attribute instance-attribute

envelope_templates: Optional[List[EnvelopeTemplate | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'envelopeTemplates'})

The available envelope templates.

AddDocumentsToEnvelopeInput dataclass

AddDocumentsToEnvelopeInput(*, documents: Optional[List[Dict[str, Any]]] = None)

Add documents to an envelope

AddDocumentsResponse dataclass

AddDocumentsResponse(*, envelope_id: Optional[str] = None, envelope_documents: Optional[List[EnvelopeDocument | Mapping[str, Any]]] = None)

Response for Add documents to an envelope

Attributes

envelope_id class-attribute instance-attribute

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

The id of the envelope.

envelope_documents class-attribute instance-attribute

envelope_documents: Optional[List[EnvelopeDocument | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'envelopeDocuments'})

The documents attached to the envelope.

ListTemplateDocumentsResponse dataclass

ListTemplateDocumentsResponse(*, template_documents: Optional[List[EnvelopeDocument | Mapping[str, Any]]] = None)

Response for List documents from a template

Attributes

template_documents class-attribute instance-attribute

template_documents: Optional[List[EnvelopeDocument | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'templateDocuments'})

Documents attached to a template.

ListDocumentsResponse dataclass

ListDocumentsResponse(*, envelope_documents: Optional[List[EnvelopeDocument | Mapping[str, Any]]] = None)

Response for List documents from an envelope

Attributes

envelope_documents class-attribute instance-attribute

envelope_documents: Optional[List[EnvelopeDocument | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'envelopeDocuments'})

The documents attached to the envelope.

EnvelopeDocument dataclass

EnvelopeDocument(*, name: Optional[str] = None, document_id: Optional[str] = None, document_id_guid: Optional[str] = None, error_details: Optional[Dict[str, Any]] = None)

Response for Get document info from envelope

Attributes

name class-attribute instance-attribute

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

The name of the document.

document_id class-attribute instance-attribute

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

The id of the document.

document_id_guid class-attribute instance-attribute

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

The guid of the document.

error_details class-attribute instance-attribute

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

The error details of the document.

Tab dataclass

Tab(*, name: Optional[str] = None, tab_type: Optional[str] = None, tab_label: Optional[str] = None, value: Optional[str] = None, tab_id: Optional[str] = None, document_id: Optional[str] = None, recipient_id: Optional[str] = None, prefill: Optional[bool] = None, selected: Optional[str] = None)

Response for Get info for recipient tab

Attributes

name class-attribute instance-attribute

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

The name of the tab.

tab_type class-attribute instance-attribute

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

The type of the tab.

tab_label class-attribute instance-attribute

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

The label of the tab.

value class-attribute instance-attribute

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

The value of the tab.

tab_id class-attribute instance-attribute

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

The id of the tab.

document_id class-attribute instance-attribute

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

The id of the document.

recipient_id class-attribute instance-attribute

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

The id of the recipient.

prefill class-attribute instance-attribute

prefill: Optional[bool] = dataclass_field(default=None, kw_only=True)

Indicates whether the tab is of prefill type.

selected class-attribute instance-attribute

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

If tabs is checkbox, indicates whether the tab is selected.

AddRecipientTabsResponse dataclass

AddRecipientTabsResponse(*, recipient_tabs: Optional[List[RecipientTab | Mapping[str, Any]]] = None)

Response for Add tabs for a recipient on an envelope

Attributes

recipient_tabs class-attribute instance-attribute

recipient_tabs: Optional[List[RecipientTab | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'recipientTabs'})

The tabs added to a recipient.

RecipientTabsResponse dataclass

RecipientTabsResponse(*, recipient_tabs: Optional[List[Tab | Mapping[str, Any]]] = None)

Response for Get recipient tabs from envelope

Attributes

recipient_tabs class-attribute instance-attribute

recipient_tabs: Optional[List[Tab | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'recipientTabs'})

Recipient tab

TriggerMaestroFlowResponse dataclass

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

Response for Start Docusign workflow

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

BuildNumberResponse dataclass

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

Response for Show build Number (For reference only. Do not include in a flow for execution)

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

CreateHookEnvelopeInput dataclass

CreateHookEnvelopeInput(all_users: str, allow_envelope_publish: str, include_document_fields: str, requires_acknowledgement: str, url_to_publish_to: str, name: str, events: List[str])

When a Docusign Connect event occurs (Account-level)

Attributes

name instance-attribute

name: str

Name your Connect configuration (for example, "Envelope Events").

events instance-attribute

events: List[str]

Select an event. To include another event, select "Add new item."

CreateHookEnvelopeResponse dataclass

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

Response for When a Docusign Connect event occurs (Account-level)

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

EmbeddedSigningResponse dataclass

EmbeddedSigningResponse(*, url: Optional[str] = None)

Response for Generate Embedded Signing URL

Attributes

url class-attribute instance-attribute

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

The url of embedded signing view.

GetOrganizationsResponse dataclass

GetOrganizationsResponse(*, organizations: Optional[List[Organization | Mapping[str, Any]]] = None)

Response for Get organizations

Attributes

organizations class-attribute instance-attribute

organizations: Optional[List[Organization | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

list of organizations

ListFoldersResponse dataclass

ListFoldersResponse(*, folders: Optional[List[Folder | Mapping[str, Any]]] = None)

Response for List folders

Attributes

folders class-attribute instance-attribute

folders: Optional[List[Folder | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

Folders

ListEnvelopesResponse dataclass

ListEnvelopesResponse(*, folder_items: Optional[List[FolderItem | Mapping[str, Any]]] = None)

Response for List envelopes

Attributes

folder_items class-attribute instance-attribute

folder_items: Optional[List[FolderItem | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'folderItems'})

The envelopes within a folder.

RecipientTypesResponse dataclass

RecipientTypesResponse(*, tab_types: Optional[List[RecipientType | Mapping[str, Any]]] = None)

Response for StaticResponseForRecipientTypes

Attributes

tab_types class-attribute instance-attribute

tab_types: Optional[List[RecipientType | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'tabTypes'})

Recipient types

SignatureTypesResponse dataclass

SignatureTypesResponse(*, tab_types: Optional[List[SignatureType | Mapping[str, Any]]] = None)

Response for StaticResponseForSignatureTypes

Attributes

tab_types class-attribute instance-attribute

tab_types: Optional[List[SignatureType | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'tabTypes'})

Signature types

ListSigningGroupResponse dataclass

ListSigningGroupResponse(*, signing_groups: Optional[List[SigningGroup | Mapping[str, Any]]] = None)

Response for GetSigningGroups

Attributes

signing_groups class-attribute instance-attribute

signing_groups: Optional[List[SigningGroup | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'signingGroups'})

List of all signing groups

TabTypesResponse dataclass

TabTypesResponse(*, tab_types: Optional[List[TabType | Mapping[str, Any]]] = None)

Response for StaticResponseForTabTypes

Attributes

tab_types class-attribute instance-attribute

tab_types: Optional[List[TabType | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'tabTypes'})

Tab types

WorkflowDefinitionsResponse dataclass

WorkflowDefinitionsResponse(*, workflow_definitions: Optional[List[WorkflowDefinition | Mapping[str, Any]]] = None)

Response for Get Maestro Workflow Definitions

Attributes

workflow_definitions class-attribute instance-attribute

workflow_definitions: Optional[List[WorkflowDefinition | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'WorkflowDefinitions'})

WorkflowDefinitions

GetWorkFlowIdsResponse dataclass

GetWorkFlowIdsResponse(*, workflow_ids: Optional[List[WorkflowId | Mapping[str, Any]]] = None)

Response for Get All Workflow Ids

Attributes

workflow_ids class-attribute instance-attribute

workflow_ids: Optional[List[WorkflowId | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'workflowIds'})

Workflow ID

WorkflowDefinitionResponse dataclass

WorkflowDefinitionResponse(*, id: Optional[str] = None, name: Optional[str] = None, payload_schema: Optional[List[WorkflowDefPayloadSchema | Mapping[str, Any]]] = None)

Response for Get Maestro Workflow Definition

Attributes

id class-attribute instance-attribute

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

Id

name class-attribute instance-attribute

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

Name

GetDynamicSignersResponse dataclass

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

Response for Get the signers of a template in dynamic schema format

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

GetDynamicRecipientsResponse dataclass

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

Response for Get the signers of a template in dynamic schema format

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

StaticResponseForRecipientTypeSchemaResponse dataclass

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

Response for StaticResponseForRecipientTypeSchema

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

StaticResponseForVerificationTypeSchemaResponse dataclass

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

Response for StaticResponseForVerificationTypeSchema

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

StaticResponseForEmbeddedSenderSchemaResponse dataclass

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

Response for StaticResponseForEmbeddedSenderSchema

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

StaticResponseForEmbeddedSigningSchemaResponse dataclass

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

Response for StaticResponseForEmbeddedSigningSchema

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

StaticResponseForBuildNumberSchemaResponse dataclass

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

Response for StaticResponseForBuildNumberSchema

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

StaticResponseForAnchorTabSchemaResponse dataclass

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

Response for StaticResponseForAnchorTabSchema

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

StaticResponseForCompositeTemplatesResponse dataclass

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

Response for StaticResponseForCompositeTemplates

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

WebhookRequest dataclass

WebhookRequest(all_users: str, allow_envelope_publish: str, include_document_fields: str, requires_acknowledgement: str, url_to_publish_to: str, name: str, envelope_events: str)

Definition: WebhookRequest

WebhookEnvelopeResponse dataclass

WebhookEnvelopeResponse(*, data: Optional[Dict[str, Any]] = None)

Definition: WebhookEnvelopeResponse

WebhookOrganizationResponse dataclass

WebhookOrganizationResponse(*, data: Optional[Dict[str, Any]] = None)

Definition: WebhookOrganizationResponse

WorkflowDefinition dataclass

WorkflowDefinition(*, id: Optional[str] = None, name: Optional[str] = None)

Definition: WorkflowDefinition

Attributes

id class-attribute instance-attribute

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

Id

name class-attribute instance-attribute

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

Name

WorkflowDefPayloadSchema dataclass

WorkflowDefPayloadSchema(*, property_name: Optional[str] = None, type_: Optional[str] = None)

Definition: WorkflowDefPayloadSchema

Attributes

property_name class-attribute instance-attribute

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

Name

type_ class-attribute instance-attribute

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

Type

MaestroInputVariables dataclass

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

Definition: MaestroInputVariables

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

DynamicSigners dataclass

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

Definition: DynamicSigners

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

DynamicRecipients dataclass

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

Definition: DynamicRecipients

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

AdditionalRecipientParamsSchema dataclass

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

Definition: AdditionalRecipientParamsSchema

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

AdditionalRecipientData dataclass

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

Definition: AdditionalRecipientData

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

AdditionalURLForSenderView dataclass

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

Definition: AdditionalURLForSenderView

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

AdditionalURL dataclass

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

Definition: AdditionalURL

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

DynamicSigningUrlFields dataclass

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

Definition: DynamicSigningUrlFields

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

BuildNumberSchema dataclass

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

Definition: BuildNumberSchema

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

AccountCustomFields dataclass

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

Definition: AccountCustomFields

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

AnchorTabSchema dataclass

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

Definition: AnchorTabSchema

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

CompositeTemplateSchema dataclass

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

Definition: CompositeTemplateSchema

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

AddRecipientToEnvelopeRequest dataclass

AddRecipientToEnvelopeRequest(*, signers: Optional[List[SignerRequest | Mapping[str, Any]]] = None)

Definition: AddRecipientToEnvelopeRequest

SignerRequest dataclass

SignerRequest(*, routing_order: Optional[str] = None, role_name: Optional[str] = None)

Definition: SignerRequest

Attributes

routing_order class-attribute instance-attribute

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

The signing order of the recipient in the document.

role_name class-attribute instance-attribute

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

The role of the signer.

OnEnvelopeStatusChangesResponse dataclass

OnEnvelopeStatusChangesResponse(*, envelopes: Optional[List[Envelope | Mapping[str, Any]]] = None)

Definition: OnEnvelopeStatusChangesResponse

Attributes

envelopes class-attribute instance-attribute

envelopes: Optional[List[Envelope | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

Envelopes

EnvelopeIds dataclass

EnvelopeIds(*, email_subject: Optional[str] = None, envelope_id: Optional[str] = None)

Definition: EnvelopeIds

Attributes

email_subject class-attribute instance-attribute

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

Title of the envelope

envelope_id class-attribute instance-attribute

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

Envelope ID

FilteredEnvelopes dataclass

FilteredEnvelopes(*, title: Optional[str] = None, description: Optional[str] = None, envelope_id: Optional[str] = None, documents: Optional[str] = None, recipients: Optional[str] = None, sender: Optional[str] = None, status: Optional[str] = None, status_date: Optional[str] = None, date_sent: Optional[str] = None, url: Optional[str] = None)

Definition: FilteredEnvelopes

Attributes

title class-attribute instance-attribute

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

Title of the envelope

description class-attribute instance-attribute

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

Description of the envelope activity

envelope_id class-attribute instance-attribute

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

Envelope ID

documents class-attribute instance-attribute

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

List of document names

recipients class-attribute instance-attribute

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

List of recipient names

sender class-attribute instance-attribute

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

Sender name

status class-attribute instance-attribute

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

Status of the envelope

status_date class-attribute instance-attribute

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

Last status update of the activity

date_sent class-attribute instance-attribute

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

Envelope sent date

url class-attribute instance-attribute

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

URL of the envelope

SalesCopilotFilteredEnvelopes dataclass

SalesCopilotFilteredEnvelopes(*, title: Optional[str] = None, sub_title: Optional[str] = None, url: Optional[str] = None, additional_properties_for_sales_envelope: Optional[Dict[str, Any]] = None)

Definition: SalesCopilotFilteredEnvelopes

Attributes

title class-attribute instance-attribute

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

Title of the envelope

sub_title class-attribute instance-attribute

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

SubTitle of the envelope

url class-attribute instance-attribute

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

URL of the envelope

additional_properties_for_sales_envelope class-attribute instance-attribute

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

Additional Properties

Activity dataclass

Activity(title: str, description: str, date_time: str, *, url: Optional[str] = None, additional_properties: Optional[Dict[str, Any]] = None)

Definition: Activity

Attributes

title instance-attribute

title: str

This output indicates the title of the activity in the citation card.

description instance-attribute

description: str

This output indicates the description of the insight.

date_time class-attribute instance-attribute

date_time: str = dataclass_field(metadata={'wire_name': 'dateTime'})

This output indicates the time associated with the insight.

url class-attribute instance-attribute

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

This output indicates the URL to open insight.

additional_properties class-attribute instance-attribute

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

This output indicates additional properties displayed in the detailed view of the insight.

EmailSummary dataclass

EmailSummary(title: str, description: str)

Definition: EmailSummary

Attributes

title class-attribute instance-attribute

title: str = dataclass_field(metadata={'wire_name': 'Title'})

This output indicates the title of the partner section and should include only the partner's name.

description class-attribute instance-attribute

description: str = dataclass_field(metadata={'wire_name': 'Description'})

This output indicates the text you would like to be included in the email summary.

KeySales dataclass

KeySales(title: str, description: str, *, url: Optional[str] = None, date_time: Optional[str] = None, additional_properties: Optional[Dict[str, Any]] = None)

Definition: KeySales

Attributes

title class-attribute instance-attribute

title: str = dataclass_field(metadata={'wire_name': 'Title'})

This output indicates the title of citation card for the insight.

description instance-attribute

description: str

This output indicates the text of the insight to be included in key sales info.

url class-attribute instance-attribute

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

This output indicates the URL to learn more about the insight.

date_time class-attribute instance-attribute

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

This output indicates the time associated with the insight.

additional_properties class-attribute instance-attribute

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

This output indicates additional properties as name-value pairs of each related insight returned by the action.

DocumentRecord dataclass

DocumentRecord(record_id: str, record_type_display_name: str, record_type_plural_display_name: str, record_type: str, record_title: str, *, url: Optional[str] = None, additional_properties: Optional[Dict[str, Any]] = None)

Definition: DocumentRecord

Attributes

record_id class-attribute instance-attribute

record_id: str = dataclass_field(metadata={'wire_name': 'recordId'})

This output uniquely identifies each related record returned by the action.

record_type_display_name class-attribute instance-attribute

record_type_display_name: str = dataclass_field(metadata={'wire_name': 'recordTypeDisplayName'})

This output indicates the display name of record type of each related record returned by the action.

record_type_plural_display_name class-attribute instance-attribute

record_type_plural_display_name: str = dataclass_field(metadata={'wire_name': 'recordTypePluralDisplayName'})

This output indicates the plural display name of the record type of each related record returned by the action.

record_type class-attribute instance-attribute

record_type: str = dataclass_field(metadata={'wire_name': 'recordType'})

This output indicates the type of each related record returned by the action.

record_title class-attribute instance-attribute

record_title: str = dataclass_field(metadata={'wire_name': 'recordTitle'})

This output indicates the title of each related record returned by the action.

url class-attribute instance-attribute

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

This output indicates the URL of each related record returned by the action.

additional_properties class-attribute instance-attribute

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

Additional Properties

Envelope dataclass

Envelope(*, documents_uri: Optional[str] = None, envelope_id: Optional[str] = None, envelope_uri: Optional[str] = None, notification_uri: Optional[str] = None, recipients_uri: Optional[str] = None, status: Optional[str] = None, status_changed_date_time: Optional[str] = None)

Definition: Envelope

Attributes

documents_uri class-attribute instance-attribute

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

The URI for the document in DocuSign.

envelope_id class-attribute instance-attribute

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

The id of the envelope.

envelope_uri class-attribute instance-attribute

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

The URI for the envelope in DocuSign.

notification_uri class-attribute instance-attribute

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

The URI for the notifications.

recipients_uri class-attribute instance-attribute

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

The URI for the recipients of the envelope in DocuSign.

status class-attribute instance-attribute

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

The status of the envelope.

status_changed_date_time class-attribute instance-attribute

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

The datetime the status changed.

CombinedEmailBodyAndCustomFields dataclass

CombinedEmailBodyAndCustomFields(*, email_blurb: Optional[str] = None, account_custom_fields: Optional[AccountCustomFields | Mapping[str, Any]] = None)

Definition: CombinedEmailBodyAndCustomFields

Attributes

email_blurb class-attribute instance-attribute

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

Body of the email.

EnvelopeIDsResponse dataclass

EnvelopeIDsResponse(*, envelopes: Optional[List[EnvelopeIds | Mapping[str, Any]]] = None)

Definition: EnvelopeIDsResponse

Attributes

envelopes class-attribute instance-attribute

envelopes: Optional[List[EnvelopeIds | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

list of envelope ids

FilteredSalesCopilotEnvelopeListResponse dataclass

FilteredSalesCopilotEnvelopeListResponse(*, value: Optional[List[SalesCopilotFilteredEnvelopes | Mapping[str, Any]]] = None, has_more_results: Optional[bool] = None)

Definition: FilteredSalesCopilotEnvelopeListResponse

Attributes

value class-attribute instance-attribute

value: Optional[List[SalesCopilotFilteredEnvelopes | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

Filtered envelopes

ActivityListResponseEnvelope dataclass

ActivityListResponseEnvelope(*, value: Optional[List[Activity | Mapping[str, Any]]] = None, has_more_results: Optional[bool] = None)

Definition: ActivityListResponseEnvelope

Attributes

value class-attribute instance-attribute

value: Optional[List[Activity | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

Related activies

EmailSummaryResponse dataclass

EmailSummaryResponse(*, value: Optional[List[EmailSummary | Mapping[str, Any]]] = None, has_more_results: Optional[bool] = None)

Definition: EmailSummaryResponse

Attributes

value class-attribute instance-attribute

value: Optional[List[EmailSummary | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

Key Sales

KeySalesResponse dataclass

KeySalesResponse(*, value: Optional[List[KeySales | Mapping[str, Any]]] = None, has_more_results: Optional[bool] = None)

Definition: KeySalesResponse

Attributes

value class-attribute instance-attribute

value: Optional[List[KeySales | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

Key Sales

DocumentRecordListResponseEnvelope dataclass

DocumentRecordListResponseEnvelope(*, value: Optional[List[DocumentRecord | Mapping[str, Any]]] = None, has_more_results: Optional[bool] = None)

Definition: DocumentRecordListResponseEnvelope

Attributes

value class-attribute instance-attribute

value: Optional[List[DocumentRecord | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

Related records

ApiError dataclass

ApiError(error_code: str, *, error_message: Optional[str] = None, activity_id: Optional[str] = None, details: Optional[Dict[str, Any]] = None)

Definition: ApiError

Organization dataclass

Organization(*, id: Optional[str] = None, name: Optional[str] = None)

Definition: organization

Attributes

id class-attribute instance-attribute

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

The id of the organization.

name class-attribute instance-attribute

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

The name of the organization.

LoginAccount dataclass

LoginAccount(account_id_guid: str, *, name: Optional[str] = None)

Definition: LoginAccount

Attributes

name class-attribute instance-attribute

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

The name of the account.

account_id_guid class-attribute instance-attribute

account_id_guid: str = dataclass_field(metadata={'wire_name': 'accountIdGuid'})

The GUID of the account.

DocumentTypesResponse dataclass

DocumentTypesResponse(*, document_types: Optional[List[DocumentType | Mapping[str, Any]]] = None)

Definition: DocumentTypesResponse

Attributes

document_types class-attribute instance-attribute

document_types: Optional[List[DocumentType | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'documentTypes'})

Document types

DocGenFormField dataclass

DocGenFormField(*, document_id: Optional[str] = None, label: Optional[str] = None, type_: Optional[str] = None, name: Optional[str] = None, value: Optional[str] = None)

Definition: DocGenFormField

Attributes

document_id class-attribute instance-attribute

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

Document Id.

label class-attribute instance-attribute

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

Label.

type_ class-attribute instance-attribute

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

Type.

name class-attribute instance-attribute

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

Name.

value class-attribute instance-attribute

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

Value.

FontNamesResponse dataclass

FontNamesResponse(*, font_names: Optional[List[FontName | Mapping[str, Any]]] = None)

Definition: FontNamesResponse

Attributes

font_names class-attribute instance-attribute

font_names: Optional[List[FontName | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'fontNames'})

Font names

DocumentType dataclass

DocumentType(*, name: Optional[str] = None)

Definition: DocumentType

Attributes

name class-attribute instance-attribute

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

The type of a document.

TabType dataclass

TabType(*, name: Optional[str] = None, type_: Optional[str] = None)

Definition: TabType

Attributes

name class-attribute instance-attribute

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

Display name of the tab.

type_ class-attribute instance-attribute

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

Type of the tab.

WorkflowId dataclass

WorkflowId(*, name: Optional[str] = None, type_: Optional[str] = None)

Definition: WorkflowID

Attributes

name class-attribute instance-attribute

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

The name of workflowID

type_ class-attribute instance-attribute

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

The type of workflowID

RecipientType dataclass

RecipientType(*, name: Optional[str] = None, type_: Optional[str] = None)

Definition: RecipientType

Attributes

name class-attribute instance-attribute

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

Display name of the recipient type.

type_ class-attribute instance-attribute

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

Type of the recipient.

SignatureType dataclass

SignatureType(*, name: Optional[str] = None, type_: Optional[str] = None)

Definition: SignatureType

Attributes

name class-attribute instance-attribute

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

Display name of the signature type.

type_ class-attribute instance-attribute

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

Type of the signature.

FontName dataclass

FontName(*, name: Optional[str] = None)

Definition: FontName

Attributes

name class-attribute instance-attribute

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

The name of a font metadata.

SigningGroup dataclass

SigningGroup(signing_group_id: str, *, group_name: Optional[str] = None)

Definition: SigningGroup

Attributes

signing_group_id class-attribute instance-attribute

signing_group_id: str = dataclass_field(metadata={'wire_name': 'signingGroupId'})

The ID of the signing group.

group_name class-attribute instance-attribute

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

The name of the signing group.

EnvelopeTemplate dataclass

EnvelopeTemplate(template_id: str, *, name: Optional[str] = None)

Definition: EnvelopeTemplate

Attributes

template_id class-attribute instance-attribute

template_id: str = dataclass_field(metadata={'wire_name': 'templateId'})

The id of the template.

name class-attribute instance-attribute

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

The name of the template.

Folder dataclass

Folder(*, name: Optional[str] = None, folder_id: Optional[str] = None)

Definition: Folder

Attributes

name class-attribute instance-attribute

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

The name of the folder.

folder_id class-attribute instance-attribute

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

The id of the folder.

FolderItem dataclass

FolderItem(*, envelope_id: Optional[str] = None, subject: Optional[str] = None)

Definition: FolderItem

Attributes

envelope_id class-attribute instance-attribute

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

The id of the envelope.

subject class-attribute instance-attribute

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

The subject of the envelope.

RecipientTab dataclass

RecipientTab(*, tab_id: Optional[str] = None, tab_type: Optional[str] = None)

Definition: RecipientTab

Attributes

tab_id class-attribute instance-attribute

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

The id of the tab.

tab_type class-attribute instance-attribute

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

The type of the tab.

EnvelopeDocumentField dataclass

EnvelopeDocumentField(*, name: Optional[str] = None, value: Optional[str] = None)

Definition: EnvelopeDocumentField

Attributes

name class-attribute instance-attribute

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

The name of the custom field.

value class-attribute instance-attribute

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

The value of the custom field.

DeclineReasonWithoutType dataclass

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

Definition: DeclineReasonWithoutType

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

DocusignClient

DocusignClient(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 docusign connector.

Initialize a DocusignClient.

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:

list_docgen_form_fields

list_docgen_form_fields(account_id: str, envelope_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 document generation form fields from envelope

Get document generation form fields from envelope

Returns a single-page Azure Core async collection.

Swagger operation ID: GetDocgenFormFields.

Parameters:

Name	Type	Description	Default
account_id	str	Enter or select an account ID.	required
envelope_id	str	Enter an envelope 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
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.

update_docgen_form_fields async

update_docgen_form_fields(input: UpdateDocgenFormFieldsInput, account_id: str, envelope_id: str, document_guid: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Update document generation form fields from envelope

Update document generation form fields from envelope

Swagger operation ID: UpdateDocgenFormFields.

Parameters:

Name	Type	Description	Default
input	UpdateDocgenFormFieldsInput	The request body.	required
account_id	str	Enter or select an account ID.	required
envelope_id	str	Enter an envelope ID.	required
document_guid	str	Document GUID.	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_doc_gen_template_tabs async

get_doc_gen_template_tabs(account_id: str, template_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

Get document generation form fields from template (bulk send templates only)

Get document generation form fields from template (bulk send templates only)

Swagger operation ID: GetDocGenTemplateTabs.

Parameters:

Name	Type	Description	Default
account_id	str	Enter or select an account ID.	required
template_id	str	Enter or select a template 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.

void_envelope async

void_envelope(account_id: str, envelope_id: str, voided_reason: 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

Void the envelope

Void the envelope.

Swagger operation ID: VoidEnvelope.

Parameters:

Name	Type	Description	Default
account_id	str	Enter or select an account ID.	required
envelope_id	str	Enter an envelope ID.	required
voided_reason	str	Voided reason.	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.

resend_envelope async

resend_envelope(envelope_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

Resend the envelope

This action resends a Docusign envelope or sends a reminder to recipients who need to sign a Docusign agreement based on a provided EnvelopeId.

Swagger operation ID: ResendEnvelope.

Parameters:

Name	Type	Description	Default
envelope_id	str	Enter an envelope 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.

add_reminders async

add_reminders(account_id: str, envelope_id: str, reminder_enabled: bool, reminder_delay: str, reminder_frequency: str, *, expire_after: 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

Add reminders for an envelope

Add reminders for an envelope

Swagger operation ID: AddReminders.

Parameters:

Name	Type	Description	Default
account_id	str	Enter or select an account ID.	required
envelope_id	str	Enter an envelope ID.	required
reminder_enabled	bool	When set to false the reminders are disabled. Default is false.	required
reminder_delay	str	Add number of days after which recipient receives reminder email.	required
reminder_frequency	str	Add number of days between reminder emails.	required
expire_after	Optional[str]	Add number of days before expiry.	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.

list_envelope_document_tabs

list_envelope_document_tabs(account_id: str, envelope_id: str, document_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 document tabs from envelope

Get document tabs from envelope

Returns a single-page Azure Core async collection.

Swagger operation ID: GetEnvelopeDocumentTabs.

Parameters:

Name	Type	Description	Default
account_id	str	Enter or select an account ID.	required
envelope_id	str	Enter an envelope ID.	required
document_id	str	Enter a 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:

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.

update_envelope_prefill_tabs async

update_envelope_prefill_tabs(input: UpdateEnvelopePrefillTabsInput, account_id: str, envelope_id: str, document_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Update envelope prefill tabs

Update values for a list of prefill tabs

Swagger operation ID: UpdateEnvelopePrefillTabs.

Parameters:

Name	Type	Description	Default
input	UpdateEnvelopePrefillTabsInput	The request body.	required
account_id	str	Enter or select an account ID.	required
envelope_id	str	Enter an envelope ID.	required
document_id	str	Enter a 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
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_template_document_tabs

list_template_document_tabs(account_id: str, template_id: str, document_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 document tabs from template

Get document tabs from template

Returns a single-page Azure Core async collection.

Swagger operation ID: GetTemplateDocumentTabs.

Parameters:

Name	Type	Description	Default
account_id	str	Enter or select an account ID.	required
template_id	str	Enter or select a template ID.	required
document_id	str	Enter a 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:

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_envelope_document_fields

list_envelope_document_fields(account_id: str, envelope_id: str, document_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 document custom fields from envelope

Get document custom fields from envelope

Returns a single-page Azure Core async collection.

Swagger operation ID: GetEnvelopeDocumentFields.

Parameters:

Name	Type	Description	Default
account_id	str	Enter or select an account ID.	required
envelope_id	str	Enter an envelope ID.	required
document_id	str	Enter a 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:

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.

composite_templates async

composite_templates(input: CompositeTemplateSchema | Mapping[str, Any], account_id: str, email_subject: str, status: str, *, email_body: Optional[str] = None, merge_roles_on_draft: 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

Create envelope using composite templates

Create envelope using composite templates

Swagger operation ID: CompositeTemplates.

Parameters:

Name	Type	Description	Default
input	CompositeTemplateSchema | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
account_id	str	Enter or select an account ID.	required
email_subject	str	Subject of the email.	required
status	str	Envelope status.	required
email_body	Optional[str]	Body of the email.	None
merge_roles_on_draft	Optional[str]	Merge roles and delete empty recipients.	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.

search_list_envelopes async

search_list_envelopes(account_id: str, *, recipient_name: Optional[str] = None, recipient_email_id: Optional[str] = None, envelope_title: Optional[str] = None, custom_field_name: Optional[str] = None, custom_field_value: Optional[str] = None, search_text: Optional[str] = None, envelope_status: Optional[str] = None, folder_ids: Optional[str] = None, order_by: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, from_date: Optional[str] = None, to_date: 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

List envelopes

This action brings back relevant Docusign envelopes based on envelope status, date range, recipient name, recipient email address, envelope title, document name, or envelope custom field value. The output is the title, description, Envelope ID, document names, sender names, envelope status, status date, date sent, and a URL of the envelope which can be used as a link to view the envelope in Docusign.

Swagger operation ID: SearchListEnvelopes.

Parameters:

Name	Type	Description	Default
account_id	str	Enter or select an account ID.	required
recipient_name	Optional[str]	This action lists envelopes based on recipient name.	None
recipient_email_id	Optional[str]	Filters envelopes by recipient email.	None
envelope_title	Optional[str]	Filters envelopes by envelope subject.	None
custom_field_name	Optional[str]	This action lists envelopes based on a name of its custom fields.	None
custom_field_value	Optional[str]	Filters by custom field value.	None
search_text	Optional[str]	Enter one keyword to find matches in envelope subjects, recipients, and custom fields.	None
envelope_status	Optional[str]	This action lists envelopes based on status of the envelope.	None
folder_ids	Optional[str]	Filters envelopes by the selected folder.	None
order_by	Optional[str]	Sorts envelopes in the selected order.	None
top	Optional[int]	Specify the number of envelopes to return (default is 10; maximum is 1,000).	None
skip	Optional[int]	Specify the number of envelopes to skip from the start.	None
from_date	Optional[str]	Enter start date-time in UTC format: 2017-05-02T01:44z.	None
to_date	Optional[str]	Enter end date-time in UTC format: 2017-05-02T01:44z.	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.

create_envelope_from_template_no_recipients async

create_envelope_from_template_no_recipients(account_id: str, template_id: str, status: 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

Create envelope using template

Create a new envelope using a specified template.

Swagger operation ID: CreateEnvelopeFromTemplateNoRecipients.

Parameters:

Name	Type	Description	Default
account_id	str	Enter or select an account ID.	required
template_id	str	Enter or select a template ID.	required
status	str	Envelope status.	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_envelope async

send_envelope(input: DynamicSigners | Mapping[str, Any], account_id: str, status: str, template_id: str, *, email_subject: Optional[str] = None, email_body: 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

Create envelope using template with recipients

Create a new envelope using a specified template and specify recipients.

Swagger operation ID: SendEnvelope.

Parameters:

Name	Type	Description	Default
input	DynamicSigners | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
account_id	str	Enter or select an account ID.	required
status	str	Envelope status.	required
template_id	str	Enter or select a template ID.	required
email_subject	Optional[str]	Email subject.	None
email_body	Optional[str]	Email body.	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.

send_envelope_with_recipient_fields async

send_envelope_with_recipient_fields(input: DynamicRecipients | Mapping[str, Any], account_id: str, template_id: str, *, merge_roles_on_draft: Optional[str] = None, email_subject: 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

Create envelope using template with recipients and tabs

Create envelope using template with recipients and tabs

Swagger operation ID: SendEnvelopeWithRecipientFields.

Parameters:

Name	Type	Description	Default
input	DynamicRecipients | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
account_id	str	Enter or select an account ID.	required
template_id	str	Enter or select a template ID.	required
merge_roles_on_draft	Optional[str]	Merge roles and delete empty recipients.	None
email_subject	Optional[str]	Email subject.	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.

send_draft_envelope async

send_draft_envelope(account_id: str, envelope_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

Send envelope

Send an existing envelope.

Swagger operation ID: SendDraftEnvelope.

Parameters:

Name	Type	Description	Default
account_id	str	Enter or select an account ID.	required
envelope_id	str	Enter an envelope 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_envelope_custom_field async

get_envelope_custom_field(account_id: str, envelope_id: str, field_name: 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

Get envelope custom field info

Get envelope custom field info.

Swagger operation ID: GetEnvelopeCustomField.

Parameters:

Name	Type	Description	Default
account_id	str	Enter or select an account ID.	required
envelope_id	str	Enter an envelope ID.	required
field_name	str	Custom Field Name.	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_envelope_custom_field async

update_envelope_custom_field(account_id: str, envelope_id: str, field_id: str, field_type: str, name: str, value: 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 envelope custom field

Update value for the specified envelope custom field

Swagger operation ID: UpdateEnvelopeCustomField.

Parameters:

Name	Type	Description	Default
account_id	str	Enter or select an account ID.	required
envelope_id	str	Enter an envelope ID.	required
field_id	str	Custom Field ID.	required
field_type	str	Custom Field Type.	required
name	str	Custom Field Name.	required
value	str	Custom Field Value.	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.

generate_embedded_sender_url async

generate_embedded_sender_url(input: AdditionalURLForSenderView | Mapping[str, Any], account_id: str, envelope_id: str, open_in: str, return_url: 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

Generate Embedded Sender URL

Generate Embedded Sender URL

Swagger operation ID: GenerateEmbeddedSenderURL.

Parameters:

Name	Type	Description	Default
input	AdditionalURLForSenderView | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
account_id	str	Enter or select an account ID.	required
envelope_id	str	Enter an envelope ID.	required
open_in	str	Open in.	required
return_url	str	Return URL.	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_recipient_status async

get_recipient_status(account_id: str, envelope_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

List recipients from an envelope

List recipients from an envelope

Swagger operation ID: GetRecipientStatus.

Parameters:

Name	Type	Description	Default
account_id	str	Enter or select an account ID.	required
envelope_id	str	Enter an envelope 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.

remove_recipient_from_envelope async

remove_recipient_from_envelope(account_id: str, envelope_id: str, folder_id: str, remove_recipient_from_envelope_recipient_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

Remove recipient from an envelope

Remove recipient from an envelope

Swagger operation ID: RemoveRecipientFromEnvelope.

Parameters:

Name	Type	Description	Default
account_id	str	Enter or select an account ID.	required
envelope_id	str	Enter an envelope ID.	required
folder_id	str	Folder ID.	required
remove_recipient_from_envelope_recipient_id	str	Recipient 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_recipient_fields async

get_recipient_fields(account_id: str, envelope_id: str, *, recipient_email: Optional[str] = None, area_code: Optional[str] = None, phone_number: Optional[str] = None, recipient_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

Get recipient info from envelope

Get recipient info from envelope

Swagger operation ID: GetRecipientFields.

Parameters:

Name	Type	Description	Default
account_id	str	Enter or select an account ID.	required
envelope_id	str	Enter an envelope ID.	required
recipient_email	Optional[str]	Recipient email.	None
area_code	Optional[str]	Area code of the recipient.	None
phone_number	Optional[str]	Phone number of the recipient.	None
recipient_id	Optional[str]	Enter a recipient ID.	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.

get_audit_events async

get_audit_events(account_id: str, envelope_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

Get audit event list

Get audit event list

Swagger operation ID: GetAuditEvents.

Parameters:

Name	Type	Description	Default
account_id	str	Enter or select an account ID.	required
envelope_id	str	Enter an envelope 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.

add_verification_to_recipient async

add_verification_to_recipient(input: AdditionalRecipientData | Mapping[str, Any], account_id: str, envelope_id: str, recipient_id: str, recipient_type: str, verification_type: 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

Add verification type to a recipient

Add verification type to a recipient.

Swagger operation ID: AddVerificationToRecipient.

Parameters:

Name	Type	Description	Default
input	AdditionalRecipientData | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
account_id	str	Enter or select an account ID.	required
envelope_id	str	Enter an envelope ID.	required
recipient_id	str	Enter a recipient ID.	required
recipient_type	str	Enter or select a recipient type.	required
verification_type	str	Verification type.	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_envelope_recipient async

update_envelope_recipient(input: AdditionalRecipientParamsSchema | Mapping[str, Any], account_id: str, envelope_id: str, recipient_id: str, recipient_type: str, *, signature_type: Optional[str] = None, client_user_id: Optional[str] = None, embedded_recipient_start_u_r_l: Optional[str] = None, routing_order: Optional[str] = None, email_notification_language: Optional[str] = None, email_notification_subject: Optional[str] = None, email_notification_body: Optional[str] = None, note: Optional[str] = None, role_name: Optional[str] = None, country_code: Optional[str] = None, phone_number: Optional[str] = None, signing_group_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

Update recipient on an envelope

Update recipient on an envelope

Swagger operation ID: UpdateEnvelopeRecipient.

Parameters:

Name	Type	Description	Default
input	AdditionalRecipientParamsSchema | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
account_id	str	Enter or select an account ID.	required
envelope_id	str	Enter an envelope ID.	required
recipient_id	str	Enter a recipient ID.	required
recipient_type	str	Recipient type.	required
signature_type	Optional[str]	DocuSign standards-based-signature (SBS) types.	None
client_user_id	Optional[str]	Client user ID for embedded signer.	None
embedded_recipient_start_u_r_l	Optional[str]	A sender-provided URL string for redirecting an embedded recipient.	None
routing_order	Optional[str]	The signing order of the recipient.	None
email_notification_language	Optional[str]	Language for the email notification.	None
email_notification_subject	Optional[str]	Subject of the email notification.	None
email_notification_body	Optional[str]	Body of the email notification.	None
note	Optional[str]	Custom note for the recipient.	None
role_name	Optional[str]	Role name associated with the recipient.	None
country_code	Optional[str]	For SMS notifications, the country code, without leading + sign.	None
phone_number	Optional[str]	Signer email or SMS phone required. Exclude country code for phone number.	None
signing_group_id	Optional[str]	Signing Group.	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.

apply_templates_to_documents async

apply_templates_to_documents(input: ApplyTemplatesToDocumentsInput | Mapping[str, Any], account_id: str, envelope_id: str, template_id: str, *, preserve_template_recipient: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Apply a template to documents

Apply a template to documents

Swagger operation ID: ApplyTemplatesToDocuments.

Parameters:

Name	Type	Description	Default
input	ApplyTemplatesToDocumentsInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
account_id	str	Enter or select an account ID.	required
envelope_id	str	Enter an envelope ID.	required
template_id	str	Enter or select a template ID.	required
preserve_template_recipient	Optional[str]	False.	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:

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

Raises:

Type	Description
ConnectorException	If the connector request fails.

create_bulk_send_list async

create_bulk_send_list(input: CreateBulkSendListInput | Mapping[str, Any], account_id: str, name: 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

Create bulk send list

Create bulk send list

Swagger operation ID: CreateBulkSendList.

Parameters:

Name	Type	Description	Default
input	CreateBulkSendListInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
account_id	str	Enter or select an account ID.	required
name	str	Bulk send list name.	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.

bulk_send async

bulk_send(account_id: str, bulk_send_list_id: str, envelope_or_template_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

Bulk send envelope using template

Bulk send envelope using template

Swagger operation ID: BulkSend.

Parameters:

Name	Type	Description	Default
account_id	str	Enter or select an account ID.	required
bulk_send_list_id	str	Bulk send list GUID.	required
envelope_or_template_id	str	Enter the template ID, or choose a template from the dropdown.	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_login_accounts

list_login_accounts(*, 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]]

Login

Login

Returns a single-page Azure Core async collection.

Swagger operation ID: GetLoginAccounts.

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.

list_envelope_templates

list_envelope_templates(account_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]]

List templates

List templates for a specific account.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetEnvelopeTemplates.

Parameters:

Name	Type	Description	Default
account_id	str	Enter or select an account 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
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.

add_documents_to_envelope async

add_documents_to_envelope(input: AddDocumentsToEnvelopeInput | Mapping[str, Any], account_id: str, envelope_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

Add documents to an envelope

Add documents to an envelope.

Swagger operation ID: AddDocumentsToEnvelope.

Parameters:

Name	Type	Description	Default
input	AddDocumentsToEnvelopeInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
account_id	str	Enter or select an account ID.	required
envelope_id	str	Enter an envelope 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.

list_template_documents

list_template_documents(account_id: str, template_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]]

List documents from a template

List documents from a template

Returns a single-page Azure Core async collection.

Swagger operation ID: ListTemplateDocuments.

Parameters:

Name	Type	Description	Default
account_id	str	Enter or select an account ID.	required
template_id	str	Enter or select a template 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
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_envelope_documents

list_envelope_documents(account_id: str, envelope_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]]

List documents from an envelope

List documents from an envelope

Returns a single-page Azure Core async collection.

Swagger operation ID: ListEnvelopeDocuments.

Parameters:

Name	Type	Description	Default
account_id	str	Enter or select an account ID.	required
envelope_id	str	Enter an envelope 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
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_envelope_document_info async

get_envelope_document_info(account_id: str, envelope_id: str, document_name: 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

Get document info from envelope

Get document info from envelope

Swagger operation ID: GetEnvelopeDocumentInfo.

Parameters:

Name	Type	Description	Default
account_id	str	Enter or select an account ID.	required
envelope_id	str	Enter an envelope ID.	required
document_name	str	File name with extension.	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_tab_info async

get_tab_info(account_id: str, envelope_id: str, recipient_id: str, tab_label: 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

Get info for recipient tab

Returns the value of the tab for the given recipient

Swagger operation ID: GetTabInfo.

Parameters:

Name	Type	Description	Default
account_id	str	Enter or select an account ID.	required
envelope_id	str	Enter an envelope ID.	required
recipient_id	str	Enter a recipient ID.	required
tab_label	str	Tab label.	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.

add_recipient_tabs async

add_recipient_tabs(input: AnchorTabSchema | Mapping[str, Any], account_id: str, envelope_id: str, recipient_id: str, tab_type: 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

Add tabs for a recipient on an envelope

Add tabs for a recipient on an envelope

Swagger operation ID: AddRecipientTabs.

Parameters:

Name	Type	Description	Default
input	AnchorTabSchema | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
account_id	str	Enter or select an account ID.	required
envelope_id	str	Enter an envelope ID.	required
recipient_id	str	Enter a recipient ID.	required
tab_type	str	Tab type.	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_recipient_tabs_values async

update_recipient_tabs_values(input: UpdateRecipientTabsValuesInput, account_id: str, envelope_id: str, recipient_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Update recipient tab values on an envelope

Update recipient tab values on an envelope

Swagger operation ID: UpdateRecipientTabsValues.

Parameters:

Name	Type	Description	Default
input	UpdateRecipientTabsValuesInput	The request body.	required
account_id	str	Enter or select an account ID.	required
envelope_id	str	Enter an envelope ID.	required
recipient_id	str	Enter a recipient 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.

list_envelope_recipient_tabs

list_envelope_recipient_tabs(account_id: str, envelope_id: str, recipient_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 recipient tabs from envelope

Get recipient tabs from envelope

Returns a single-page Azure Core async collection.

Swagger operation ID: GetEnvelopeRecipientTabs.

Parameters:

Name	Type	Description	Default
account_id	str	Enter or select an account ID.	required
envelope_id	str	Enter an envelope ID.	required
recipient_id	str	Enter a recipient 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
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.

trigger_maestro_flow async

trigger_maestro_flow(input: MaestroInputVariables | Mapping[str, Any], account_id: str, workflow_id: str, instance_name: 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

Start Docusign workflow

Start Docusign workflow

Swagger operation ID: TriggerMaestroFlow.

Parameters:

Name	Type	Description	Default
input	MaestroInputVariables | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
account_id	str	Enter or select an account ID.	required
workflow_id	str	Enter the workflow ID or select the workflow name from the dropdown.	required
instance_name	str	Name of the workflow instance.	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.

build_number async

build_number(input: BuildNumberSchema | Mapping[str, Any], *, 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

Show build Number (For reference only. Do not include in a flow for execution)

Identifier for the currently deployed build.

Swagger operation ID: BuildNumber.

Parameters:

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

add_recipient_to_envelope async

add_recipient_to_envelope(input: AdditionalRecipientParamsSchema | Mapping[str, Any], account_id: str, envelope_id: str, recipient_type: str, *, client_user_id: Optional[str] = None, recipient_id: Optional[str] = None, embedded_recipient_start_u_r_l: Optional[str] = None, routing_order: Optional[str] = None, email_notification_language: Optional[str] = None, email_notification_subject: Optional[str] = None, email_notification_body: Optional[str] = None, note: Optional[str] = None, role_name: Optional[str] = None, country_code: Optional[str] = None, phone_number: Optional[str] = None, signing_group_id: Optional[str] = None, signature_type: Optional[str] = None, workflow_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

Add recipient to an envelope

Add recipient to an envelope.

Swagger operation ID: AddRecipientToEnvelopeV2.

Parameters:

Name	Type	Description	Default
input	AdditionalRecipientParamsSchema | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
account_id	str	Enter or select an account ID.	required
envelope_id	str	Enter an envelope ID.	required
recipient_type	str	Enter or select a recipient type.	required
client_user_id	Optional[str]	Client user ID for embedded signer.	None
recipient_id	Optional[str]	Enter a recipient ID.	None
embedded_recipient_start_u_r_l	Optional[str]	A sender-provided URL string for redirecting an embedded recipient.	None
routing_order	Optional[str]	The signing order of the recipient.	None
email_notification_language	Optional[str]	Language for the email notification.	None
email_notification_subject	Optional[str]	Subject of the email notification.	None
email_notification_body	Optional[str]	Body of the email notification.	None
note	Optional[str]	Custom note for the recipient.	None
role_name	Optional[str]	Role name associated with the recipient.	None
country_code	Optional[str]	For SMS notifications, the country code, without leading + sign.	None
phone_number	Optional[str]	Signer email or SMS phone required. Exclude country code for phone number.	None
signing_group_id	Optional[str]	Signing Group.	None
signature_type	Optional[str]	DocuSign standards-based-signature (SBS) types.	None
workflow_id	Optional[str]	IDV workflows with pen signature types must be selected here.	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.

create_blank_envelope async

create_blank_envelope(input: CombinedEmailBodyAndCustomFields | Mapping[str, Any], account_id: str, email_subject: 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

Create envelope

Create a new blank envelope.

Swagger operation ID: CreateBlankEnvelopeV2.

Parameters:

Name	Type	Description	Default
input	CombinedEmailBodyAndCustomFields | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
account_id	str	Enter or select an account ID.	required
email_subject	str	Subject of the email.	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.

generate_embedded_signing_url async

generate_embedded_signing_url(input: DynamicSigningUrlFields | Mapping[str, Any], account_id: str, envelope_id: str, is_in_person_signer: str, authentication_method: str, return_url: 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

Generate Embedded Signing URL

Generate Embedded Signing URL

Swagger operation ID: GenerateEmbeddedSigningURLV2.

Parameters:

Name	Type	Description	Default
input	DynamicSigningUrlFields | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
account_id	str	Enter or select an account ID.	required
envelope_id	str	Enter an envelope ID.	required
is_in_person_signer	str	Yes/No.	required
authentication_method	str	Authentication Method.	required
return_url	str	Return URL.	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_documents async

get_documents(account_id: str, envelope_id: str, document_id: str, *, language: 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

Get documents from an envelope

Get documents from an envelope

Swagger operation ID: GetDocumentsV2.

Parameters:

Name	Type	Description	Default
account_id	str	Enter or select an account ID.	required
envelope_id	str	Enter an envelope ID.	required
document_id	str	Enter "string(document ID)" to get a single document, or select a format.	required
language	Optional[str]	Select language.	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.

list_organizations

list_organizations(*, 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 organizations

Get organizations

Returns a single-page Azure Core async collection.

Swagger operation ID: GetOrganizations.

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.

get_account_custom_fields async

get_account_custom_fields(account_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 account custom fields

Get the custom fields for a specified account.

Swagger operation ID: GetAccountCustomFields.

Parameters:

Name	Type	Description	Default
account_id	str	Account 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.

list_get_folder

list_get_folder(account_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]]

List folders

List folders for a specific account.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetFolderList.

Parameters:

Name	Type	Description	Default
account_id	str	Account 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
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_get_folder_envelope

list_get_folder_envelope(account_id: str, folder_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]]

List envelopes

List envelopes under a particular folder.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetFolderEnvelopeList.

Parameters:

Name	Type	Description	Default
account_id	str	Enter or select an account ID.	required
folder_id	str	Folder 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
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_static_response_for_recipient_types

list_static_response_for_recipient_types(*, 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]]

StaticResponseForRecipientTypes

Get recipient types.

Returns a single-page Azure Core async collection.

Swagger operation ID: StaticResponseForRecipientTypes.

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.

list_static_response_for_signature_types

list_static_response_for_signature_types(*, 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]]

StaticResponseForSignatureTypes

Get signature types.

Returns a single-page Azure Core async collection.

Swagger operation ID: StaticResponseForSignatureTypes.

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.

list_signing_groups

list_signing_groups(account_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]]

GetSigningGroups

List signing groups for a specific account.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetSigningGroups.

Parameters:

Name	Type	Description	Default
account_id	str	Account 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
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_static_response_for_tab_types

list_static_response_for_tab_types(*, 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]]

StaticResponseForTabTypes

Get tab types.

Returns a single-page Azure Core async collection.

Swagger operation ID: StaticResponseForTabTypes.

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.

list_maestro_workflow_definitions

list_maestro_workflow_definitions(account_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 Maestro Workflow Definitions

Get Maestro Workflow Definitions

Returns a single-page Azure Core async collection.

Swagger operation ID: GetMaestroWorkflowDefinitions.

Parameters:

Name	Type	Description	Default
account_id	str	accountId.	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_all_workflow_i_ds

list_all_workflow_i_ds(account_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 All Workflow Ids

Get All workflow ids

Returns a single-page Azure Core async collection.

Swagger operation ID: GetAllWorkflowIDs.

Parameters:

Name	Type	Description	Default
account_id	str	Account 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
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_maestro_workflow_definition async

get_maestro_workflow_definition(account_id: str, workflow_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

Get Maestro Workflow Definition

Get Maestro Workflow Definition

Swagger operation ID: GetMaestroWorkflowDefinition.

Parameters:

Name	Type	Description	Default
account_id	str	accountId.	required
workflow_id	str	workflowId.	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_dynamic_signers async

get_dynamic_signers(account_id: str, template_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

Get the signers of a template in dynamic schema format

Get the signers of a template in dynamic schema format.

Swagger operation ID: GetDynamicSigners.

Parameters:

Name	Type	Description	Default
account_id	str	Account to get the signers for.	required
template_id	str	Template to get the signers 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
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_dynamic_recipients async

get_dynamic_recipients(account_id: str, template_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

Get the signers of a template in dynamic schema format

Get the signers of a template in dynamic schema format.

Swagger operation ID: GetDynamicRecipients.

Parameters:

Name	Type	Description	Default
account_id	str	Account to get the signers for.	required
template_id	str	Template to get the signers 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
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

static_response_for_recipient_type_schema async

static_response_for_recipient_type_schema(recipient_type: str, *, signature_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) -> dict[str, Any] | None

StaticResponseForRecipientTypeSchema

Get schema for a specific recipient type.

Swagger operation ID: StaticResponseForRecipientTypeSchema.

Parameters:

Name	Type	Description	Default
recipient_type	str	recipient type.	required
signature_type	Optional[str]	signature type.	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.

static_response_for_verification_type_schema async

static_response_for_verification_type_schema(verification_type: 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

StaticResponseForVerificationTypeSchema

Get schema for a verification type.

Swagger operation ID: StaticResponseForVerificationTypeSchema.

Parameters:

Name	Type	Description	Default
verification_type	str	Verification Type.	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.

static_response_for_embedded_sender_schema async

static_response_for_embedded_sender_schema(return_url: 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

StaticResponseForEmbeddedSenderSchema

Get schema for return URL.

Swagger operation ID: StaticResponseForEmbeddedSenderSchema.

Parameters:

Name	Type	Description	Default
return_url	str	Return URL.	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.

static_response_for_embedded_signing_schema async

static_response_for_embedded_signing_schema(return_url: str, is_in_person_signer: 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

StaticResponseForEmbeddedSigningSchema

Get schema for return URL.

Swagger operation ID: StaticResponseForEmbeddedSigningSchemaV2.

Parameters:

Name	Type	Description	Default
return_url	str	Return URL.	required
is_in_person_signer	str	Is this an in-person signer?	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.

static_response_for_build_number_schema async

static_response_for_build_number_schema(*, 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

StaticResponseForBuildNumberSchema

Get schema for a build number.

Swagger operation ID: StaticResponseForBuildNumberSchema.

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.

get_custom_fields async

get_custom_fields(account_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 custom fields from an account

Get custom fields from an account

Swagger operation ID: GetCustomFields.

Parameters:

Name	Type	Description	Default
account_id	str	Account 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.

static_response_for_anchor_tab_schema async

static_response_for_anchor_tab_schema(tab_type: 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

StaticResponseForAnchorTabSchema

Get schema for a specific anchor tab.

Swagger operation ID: StaticResponseForAnchorTabSchema.

Parameters:

Name	Type	Description	Default
tab_type	str	tab type.	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.

static_response_for_composite_templates async

static_response_for_composite_templates(*, 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

StaticResponseForCompositeTemplates

Get schema for a composite templates.

Swagger operation ID: StaticResponseForCompositeTemplates.

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.