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: Optional[str] = None, allow_envelope_publish: Optional[str] = None, include_document_fields: Optional[str] = None, requires_acknowledgement: Optional[str] = None, url_to_publish_to: Optional[str] = None, name: Optional[str] = None, events: Optional[List[str]] = None)

When a Docusign Connect event occurs (Organization-level)

Attributes

name class-attribute instance-attribute

name: Optional[str] = None

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

events class-attribute instance-attribute

events: Optional[List[str]] = None

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

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

DocGenFormFieldsResponse dataclass

DocGenFormFieldsResponse(docgen_fields: Optional[List[DocGenFormField]] = None)

Response for Get document generation form fields from envelope

Attributes

docgen_fields class-attribute instance-attribute

docgen_fields: Optional[List[DocGenFormField]] = field(default=None, 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] = field(default_factory=dict)

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

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

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] = field(default=None, metadata={'wire_name': 'reminderEnabled'})

Reminder enabled

ListTabsResponse dataclass

ListTabsResponse(tabs: Optional[List[Tab]] = None)

Response for Get document tabs from envelope

Attributes

tabs class-attribute instance-attribute

tabs: Optional[List[Tab]] = None

Tabs

ListEnvelopeDocumentFieldsResponse dataclass

ListEnvelopeDocumentFieldsResponse(envelope_document_fields: Optional[List[EnvelopeDocumentField]] = None)

Response for Get document custom fields from envelope

Attributes

envelope_document_fields class-attribute instance-attribute

envelope_document_fields: Optional[List[EnvelopeDocumentField]] = field(default=None, 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] = field(default=None, metadata={'wire_name': 'envelopeId'})

The id of the envelope.

status class-attribute instance-attribute

status: Optional[str] = None

The status of the envelope.

status_date_time class-attribute instance-attribute

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

The datetime the status was set.

uri class-attribute instance-attribute

uri: Optional[str] = None

The URI for the envelope in DocuSign.

FilteredEnvelopeListResponse dataclass

FilteredEnvelopeListResponse(value: Optional[List[FilteredEnvelopes]] = None, has_more_results: Optional[bool] = None)

Response for List envelopes

Attributes

value class-attribute instance-attribute

value: Optional[List[FilteredEnvelopes]] = None

Filtered envelopes

has_more_results class-attribute instance-attribute

has_more_results: Optional[bool] = field(default=None, 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] = field(default=None, metadata={'wire_name': 'envelopeId'})

The id of the envelope.

template_id class-attribute instance-attribute

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

The id of the template.

status class-attribute instance-attribute

status: Optional[str] = None

The status of the envelope.

status_date_time class-attribute instance-attribute

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

The datetime the status was set.

uri class-attribute instance-attribute

uri: Optional[str] = None

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

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] = field(default=None, metadata={'wire_name': 'fieldId'})

The id of the envelope custom field.

field_type class-attribute instance-attribute

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

The type of the envelope custom field.

name class-attribute instance-attribute

name: Optional[str] = None

The name of the envelope custom field.

value class-attribute instance-attribute

value: Optional[str] = None

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] = field(default=None, metadata={'wire_name': 'fieldId'})

The id of the envelope custom field.

field_type class-attribute instance-attribute

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

The type of the envelope custom field.

name class-attribute instance-attribute

name: Optional[str] = None

The name of the envelope custom field.

value class-attribute instance-attribute

value: Optional[str] = None

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

The url of embedded sender view.

ListRecipientsResponse dataclass

ListRecipientsResponse(envelope_id: Optional[str] = None, signers: Optional[List[Signer]] = None)

Response for List recipients from an envelope

Attributes

signers class-attribute instance-attribute

signers: Optional[List[Signer]] = None

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] = field(default=None, metadata={'wire_name': 'routingOrder'})

The signing order of the recipient in the document.

role_name class-attribute instance-attribute

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

The role of the signer.

recipient_id class-attribute instance-attribute

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

The id the recipient.

name class-attribute instance-attribute

name: Optional[str] = None

The name of the recipient.

email class-attribute instance-attribute

email: Optional[str] = None

The email of the recipient.

recipient_type class-attribute instance-attribute

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

The type the recipient.

verification_type class-attribute instance-attribute

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

The type of verification.

recipient_id_guid class-attribute instance-attribute

recipient_id_guid: Optional[str] = field(default=None, 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] = field(default_factory=dict)

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

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]]] = field(default=None, 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] = None

Upload CSV File

raw_output class-attribute instance-attribute

raw_output: Optional[Dict[str, Any]] = field(default=None, 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] = field(default=None, metadata={'wire_name': 'listId'})

Bulk send list guid

GetLoginAccountsResponse dataclass

GetLoginAccountsResponse(login_accounts: Optional[List[LoginAccount]] = None)

Response for Login

Attributes

login_accounts class-attribute instance-attribute

login_accounts: Optional[List[LoginAccount]] = field(default=None, metadata={'wire_name': 'loginAccounts'})

Login accounts

ListTemplatesResponse dataclass

ListTemplatesResponse(envelope_templates: Optional[List[EnvelopeTemplate]] = None)

Response for List templates

Attributes

envelope_templates class-attribute instance-attribute

envelope_templates: Optional[List[EnvelopeTemplate]] = field(default=None, 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]] = None)

Response for Add documents to an envelope

Attributes

envelope_id class-attribute instance-attribute

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

The id of the envelope.

envelope_documents class-attribute instance-attribute

envelope_documents: Optional[List[EnvelopeDocument]] = field(default=None, metadata={'wire_name': 'envelopeDocuments'})

The documents attached to the envelope.

ListTemplateDocumentsResponse dataclass

ListTemplateDocumentsResponse(template_documents: Optional[List[EnvelopeDocument]] = None)

Response for List documents from a template

Attributes

template_documents class-attribute instance-attribute

template_documents: Optional[List[EnvelopeDocument]] = field(default=None, metadata={'wire_name': 'templateDocuments'})

Documents attached to a template.

ListDocumentsResponse dataclass

ListDocumentsResponse(envelope_documents: Optional[List[EnvelopeDocument]] = None)

Response for List documents from an envelope

Attributes

envelope_documents class-attribute instance-attribute

envelope_documents: Optional[List[EnvelopeDocument]] = field(default=None, 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] = None

The name of the document.

document_id class-attribute instance-attribute

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

The id of the document.

document_id_guid class-attribute instance-attribute

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

The guid of the document.

error_details class-attribute instance-attribute

error_details: Optional[Dict[str, Any]] = field(default=None, 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] = None

The name of the tab.

tab_type class-attribute instance-attribute

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

The type of the tab.

tab_label class-attribute instance-attribute

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

The label of the tab.

value class-attribute instance-attribute

value: Optional[str] = None

The value of the tab.

tab_id class-attribute instance-attribute

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

The id of the tab.

document_id class-attribute instance-attribute

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

The id of the document.

recipient_id class-attribute instance-attribute

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

The id of the recipient.

prefill class-attribute instance-attribute

prefill: Optional[bool] = None

Indicates whether the tab is of prefill type.

selected class-attribute instance-attribute

selected: Optional[str] = None

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

AddRecipientTabsResponse dataclass

AddRecipientTabsResponse(recipient_tabs: Optional[List[RecipientTab]] = None)

Response for Add tabs for a recipient on an envelope

Attributes

recipient_tabs class-attribute instance-attribute

recipient_tabs: Optional[List[RecipientTab]] = field(default=None, metadata={'wire_name': 'recipientTabs'})

The tabs added to a recipient.

RecipientTabsResponse dataclass

RecipientTabsResponse(recipient_tabs: Optional[List[Tab]] = None)

Response for Get recipient tabs from envelope

Attributes

recipient_tabs class-attribute instance-attribute

recipient_tabs: Optional[List[Tab]] = field(default=None, 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] = field(default_factory=dict)

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

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

CreateHookEnvelopeInput dataclass

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

When a Docusign Connect event occurs (Account-level)

Attributes

name class-attribute instance-attribute

name: Optional[str] = None

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

events class-attribute instance-attribute

events: Optional[List[str]] = None

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

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

The url of embedded signing view.

GetOrganizationsResponse dataclass

GetOrganizationsResponse(organizations: Optional[List[Organization]] = None)

Response for Get organizations

Attributes

organizations class-attribute instance-attribute

organizations: Optional[List[Organization]] = None

list of organizations

ListFoldersResponse dataclass

ListFoldersResponse(folders: Optional[List[Folder]] = None)

Response for List folders

Attributes

folders class-attribute instance-attribute

folders: Optional[List[Folder]] = None

Folders

ListEnvelopesResponse dataclass

ListEnvelopesResponse(folder_items: Optional[List[FolderItem]] = None)

Response for List envelopes

Attributes

folder_items class-attribute instance-attribute

folder_items: Optional[List[FolderItem]] = field(default=None, metadata={'wire_name': 'folderItems'})

The envelopes within a folder.

RecipientTypesResponse dataclass

RecipientTypesResponse(tab_types: Optional[List[RecipientType]] = None)

Response for StaticResponseForRecipientTypes

Attributes

tab_types class-attribute instance-attribute

tab_types: Optional[List[RecipientType]] = field(default=None, metadata={'wire_name': 'tabTypes'})

Recipient types

SignatureTypesResponse dataclass

SignatureTypesResponse(tab_types: Optional[List[SignatureType]] = None)

Response for StaticResponseForSignatureTypes

Attributes

tab_types class-attribute instance-attribute

tab_types: Optional[List[SignatureType]] = field(default=None, metadata={'wire_name': 'tabTypes'})

Signature types

ListSigningGroupResponse dataclass

ListSigningGroupResponse(signing_groups: Optional[List[SigningGroup]] = None)

Response for GetSigningGroups

Attributes

signing_groups class-attribute instance-attribute

signing_groups: Optional[List[SigningGroup]] = field(default=None, metadata={'wire_name': 'signingGroups'})

List of all signing groups

TabTypesResponse dataclass

TabTypesResponse(tab_types: Optional[List[TabType]] = None)

Response for StaticResponseForTabTypes

Attributes

tab_types class-attribute instance-attribute

tab_types: Optional[List[TabType]] = field(default=None, metadata={'wire_name': 'tabTypes'})

Tab types

WorkflowDefinitionsResponse dataclass

WorkflowDefinitionsResponse(workflow_definitions: Optional[List[WorkflowDefinition]] = None)

Response for Get Maestro Workflow Definitions

Attributes

workflow_definitions class-attribute instance-attribute

workflow_definitions: Optional[List[WorkflowDefinition]] = field(default=None, metadata={'wire_name': 'WorkflowDefinitions'})

WorkflowDefinitions

GetWorkFlowIdsResponse dataclass

GetWorkFlowIdsResponse(workflow_ids: Optional[List[WorkflowId]] = None)

Response for Get All Workflow Ids

Attributes

workflow_ids class-attribute instance-attribute

workflow_ids: Optional[List[WorkflowId]] = field(default=None, metadata={'wire_name': 'workflowIds'})

Workflow ID

WorkflowDefinitionResponse dataclass

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

Response for Get Maestro Workflow Definition

Attributes

id class-attribute instance-attribute

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

Id

name class-attribute instance-attribute

name: Optional[str] = field(default=None, 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] = field(default_factory=dict)

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

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

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

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

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

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

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

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

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

WebhookRequest dataclass

WebhookRequest(all_users: Optional[str] = None, allow_envelope_publish: Optional[str] = None, include_document_fields: Optional[str] = None, requires_acknowledgement: Optional[str] = None, url_to_publish_to: Optional[str] = None, name: Optional[str] = None, envelope_events: Optional[str] = None)

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] = field(default=None, metadata={'wire_name': 'Id'})

Id

name class-attribute instance-attribute

name: Optional[str] = field(default=None, 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] = field(default=None, metadata={'wire_name': 'PropertyName'})

Name

type_ class-attribute instance-attribute

type_: Optional[str] = field(default=None, 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] = field(default_factory=dict)

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

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

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

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

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

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

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

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

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

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

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

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

AddRecipientToEnvelopeRequest dataclass

AddRecipientToEnvelopeRequest(signers: Optional[List[SignerRequest]] = 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] = field(default=None, metadata={'wire_name': 'routingOrder'})

The signing order of the recipient in the document.

role_name class-attribute instance-attribute

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

The role of the signer.

OnEnvelopeStatusChangesResponse dataclass

OnEnvelopeStatusChangesResponse(envelopes: Optional[List[Envelope]] = None)

Definition: OnEnvelopeStatusChangesResponse

Attributes

envelopes class-attribute instance-attribute

envelopes: Optional[List[Envelope]] = None

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] = field(default=None, metadata={'wire_name': 'emailSubject'})

Title of the envelope

envelope_id class-attribute instance-attribute

envelope_id: Optional[str] = field(default=None, 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] = None

Title of the envelope

description class-attribute instance-attribute

description: Optional[str] = None

Description of the envelope activity

envelope_id class-attribute instance-attribute

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

Envelope ID

documents class-attribute instance-attribute

documents: Optional[str] = None

List of document names

recipients class-attribute instance-attribute

recipients: Optional[str] = None

List of recipient names

sender class-attribute instance-attribute

sender: Optional[str] = None

Sender name

status class-attribute instance-attribute

status: Optional[str] = None

Status of the envelope

status_date class-attribute instance-attribute

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

Last status update of the activity

date_sent class-attribute instance-attribute

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

Envelope sent date

url class-attribute instance-attribute

url: Optional[str] = None

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

Title of the envelope

sub_title class-attribute instance-attribute

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

SubTitle of the envelope

url class-attribute instance-attribute

url: Optional[str] = None

URL of the envelope

additional_properties_for_sales_envelope class-attribute instance-attribute

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

Additional Properties

Activity dataclass

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

Definition: Activity

Attributes

title class-attribute instance-attribute

title: Optional[str] = None

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

description class-attribute instance-attribute

description: Optional[str] = None

This output indicates the description of the insight.

date_time class-attribute instance-attribute

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

This output indicates the time associated with the insight.

url class-attribute instance-attribute

url: Optional[str] = None

This output indicates the URL to open insight.

additional_properties class-attribute instance-attribute

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

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

EmailSummary dataclass

EmailSummary(title: Optional[str] = None, description: Optional[str] = None)

Definition: EmailSummary

Attributes

title class-attribute instance-attribute

title: Optional[str] = field(default=None, 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: Optional[str] = field(default=None, metadata={'wire_name': 'Description'})

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

KeySales dataclass

KeySales(title: Optional[str] = None, description: Optional[str] = None, 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: Optional[str] = field(default=None, metadata={'wire_name': 'Title'})

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

description class-attribute instance-attribute

description: Optional[str] = None

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

url class-attribute instance-attribute

url: Optional[str] = None

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

date_time class-attribute instance-attribute

date_time: Optional[str] = field(default=None, 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]] = field(default=None, 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: Optional[str] = None, record_type_display_name: Optional[str] = None, record_type_plural_display_name: Optional[str] = None, record_type: Optional[str] = None, record_title: Optional[str] = None, url: Optional[str] = None, additional_properties: Optional[Dict[str, Any]] = None)

Definition: DocumentRecord

Attributes

record_id class-attribute instance-attribute

record_id: Optional[str] = field(default=None, 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: Optional[str] = field(default=None, 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: Optional[str] = field(default=None, 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: Optional[str] = field(default=None, 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: Optional[str] = field(default=None, 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] = None

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]] = field(default=None, 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] = field(default=None, metadata={'wire_name': 'documentsUri'})

The URI for the document in DocuSign.

envelope_id class-attribute instance-attribute

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

The id of the envelope.

envelope_uri class-attribute instance-attribute

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

The URI for the envelope in DocuSign.

notification_uri class-attribute instance-attribute

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

The URI for the notifications.

recipients_uri class-attribute instance-attribute

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

The URI for the recipients of the envelope in DocuSign.

status class-attribute instance-attribute

status: Optional[str] = None

The status of the envelope.

status_changed_date_time class-attribute instance-attribute

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

The datetime the status changed.

CombinedEmailBodyAndCustomFields dataclass

CombinedEmailBodyAndCustomFields(email_blurb: Optional[str] = None, account_custom_fields: Optional[AccountCustomFields] = None)

Definition: CombinedEmailBodyAndCustomFields

Attributes

email_blurb class-attribute instance-attribute

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

Body of the email.

EnvelopeIDsResponse dataclass

EnvelopeIDsResponse(envelopes: Optional[List[EnvelopeIds]] = None)

Definition: EnvelopeIDsResponse

Attributes

envelopes class-attribute instance-attribute

envelopes: Optional[List[EnvelopeIds]] = None

list of envelope ids

FilteredSalesCopilotEnvelopeListResponse dataclass

FilteredSalesCopilotEnvelopeListResponse(value: Optional[List[SalesCopilotFilteredEnvelopes]] = None, has_more_results: Optional[bool] = None)

Definition: FilteredSalesCopilotEnvelopeListResponse

Attributes

value class-attribute instance-attribute

value: Optional[List[SalesCopilotFilteredEnvelopes]] = None

Filtered envelopes

ActivityListResponseEnvelope dataclass

ActivityListResponseEnvelope(value: Optional[List[Activity]] = None, has_more_results: Optional[bool] = None)

Definition: ActivityListResponseEnvelope

Attributes

value class-attribute instance-attribute

value: Optional[List[Activity]] = None

Related activies

EmailSummaryResponse dataclass

EmailSummaryResponse(value: Optional[List[EmailSummary]] = None, has_more_results: Optional[bool] = None)

Definition: EmailSummaryResponse

Attributes

value class-attribute instance-attribute

value: Optional[List[EmailSummary]] = None

Key Sales

KeySalesResponse dataclass

KeySalesResponse(value: Optional[List[KeySales]] = None, has_more_results: Optional[bool] = None)

Definition: KeySalesResponse

Attributes

value class-attribute instance-attribute

value: Optional[List[KeySales]] = None

Key Sales

DocumentRecordListResponseEnvelope dataclass

DocumentRecordListResponseEnvelope(value: Optional[List[DocumentRecord]] = None, has_more_results: Optional[bool] = None)

Definition: DocumentRecordListResponseEnvelope

Attributes

value class-attribute instance-attribute

value: Optional[List[DocumentRecord]] = None

Related records

ApiError dataclass

ApiError(error_code: Optional[str] = None, 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] = None

The id of the organization.

name class-attribute instance-attribute

name: Optional[str] = None

The name of the organization.

LoginAccount dataclass

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

Definition: LoginAccount

Attributes

name class-attribute instance-attribute

name: Optional[str] = None

The name of the account.

account_id_guid class-attribute instance-attribute

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

The GUID of the account.

DocumentTypesResponse dataclass

DocumentTypesResponse(document_types: Optional[List[DocumentType]] = None)

Definition: DocumentTypesResponse

Attributes

document_types class-attribute instance-attribute

document_types: Optional[List[DocumentType]] = field(default=None, 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] = field(default=None, metadata={'wire_name': 'documentId'})

Document Id.

label class-attribute instance-attribute

label: Optional[str] = None

Label.

type_ class-attribute instance-attribute

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

Type.

name class-attribute instance-attribute

name: Optional[str] = None

Name.

value class-attribute instance-attribute

value: Optional[str] = None

Value.

FontNamesResponse dataclass

FontNamesResponse(font_names: Optional[List[FontName]] = None)

Definition: FontNamesResponse

Attributes

font_names class-attribute instance-attribute

font_names: Optional[List[FontName]] = field(default=None, metadata={'wire_name': 'fontNames'})

Font names

DocumentType dataclass

DocumentType(name: Optional[str] = None)

Definition: DocumentType

Attributes

name class-attribute instance-attribute

name: Optional[str] = None

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

Display name of the tab.

type_ class-attribute instance-attribute

type_: Optional[str] = field(default=None, 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] = None

The name of workflowID

type_ class-attribute instance-attribute

type_: Optional[str] = field(default=None, 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] = None

Display name of the recipient type.

type_ class-attribute instance-attribute

type_: Optional[str] = field(default=None, 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] = None

Display name of the signature type.

type_ class-attribute instance-attribute

type_: Optional[str] = field(default=None, 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] = None

The name of a font metadata.

SigningGroup dataclass

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

Definition: SigningGroup

Attributes

signing_group_id class-attribute instance-attribute

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

The ID of the signing group.

group_name class-attribute instance-attribute

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

The name of the signing group.

EnvelopeTemplate dataclass

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

Definition: EnvelopeTemplate

Attributes

template_id class-attribute instance-attribute

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

The id of the template.

name class-attribute instance-attribute

name: Optional[str] = None

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

The name of the folder.

folder_id class-attribute instance-attribute

folder_id: Optional[str] = field(default=None, 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] = field(default=None, metadata={'wire_name': 'envelopeId'})

The id of the envelope.

subject class-attribute instance-attribute

subject: Optional[str] = None

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] = field(default=None, metadata={'wire_name': 'tabId'})

The id of the tab.

tab_type class-attribute instance-attribute

tab_type: Optional[str] = field(default=None, 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] = None

The name of the custom field.

value class-attribute instance-attribute

value: Optional[str] = None

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

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

DocusignClient

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

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

Methods:

get_docgen_form_fields_async async

get_docgen_form_fields_async(account_id: str, envelope_id: str) -> dict[str, Any] | None

Get document generation form fields from envelope

Get document generation form fields from envelope

update_docgen_form_fields_async async

update_docgen_form_fields_async(input: UpdateDocgenFormFieldsInput, account_id: str, envelope_id: str, document_guid: str) -> None

Update document generation form fields from envelope

Update document generation form fields from envelope

get_doc_gen_template_tabs_async async

get_doc_gen_template_tabs_async(account_id: str, template_id: str) -> 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)

void_envelope_async async

void_envelope_async(account_id: str, envelope_id: str, voided_reason: str) -> dict[str, Any] | None

Void the envelope

Void the envelope.

resend_envelope_async async

resend_envelope_async(envelope_id: str) -> 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.

add_reminders_async async

add_reminders_async(account_id: str, envelope_id: str, reminder_enabled: bool, reminder_delay: str, reminder_frequency: str, expire_after: Optional[str] = None) -> dict[str, Any] | None

Add reminders for an envelope

Add reminders for an envelope

get_envelope_document_tabs_async async

get_envelope_document_tabs_async(account_id: str, envelope_id: str, document_id: str) -> dict[str, Any] | None

Get document tabs from envelope

Get document tabs from envelope

update_envelope_prefill_tabs_async async

update_envelope_prefill_tabs_async(input: UpdateEnvelopePrefillTabsInput, account_id: str, envelope_id: str, document_id: str) -> None

Update envelope prefill tabs

Update values for a list of prefill tabs

get_template_document_tabs_async async

get_template_document_tabs_async(account_id: str, template_id: str, document_id: str) -> dict[str, Any] | None

Get document tabs from template

Get document tabs from template

get_envelope_document_fields_async async

get_envelope_document_fields_async(account_id: str, envelope_id: str, document_id: str) -> dict[str, Any] | None

Get document custom fields from envelope

Get document custom fields from envelope

composite_templates_async async

composite_templates_async(input: CompositeTemplateSchema, account_id: str, email_subject: str, status: str, email_body: Optional[str] = None, merge_roles_on_draft: Optional[str] = None) -> dict[str, Any] | None

Create envelope using composite templates

Create envelope using composite templates

search_list_envelopes_async async

search_list_envelopes_async(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) -> 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.

create_envelope_from_template_no_recipients_async async

create_envelope_from_template_no_recipients_async(account_id: str, template_id: str, status: str) -> dict[str, Any] | None

Create envelope using template

Create a new envelope using a specified template.

send_envelope_async async

send_envelope_async(input: DynamicSigners, account_id: str, status: str, template_id: str, email_subject: Optional[str] = None, email_body: Optional[str] = None) -> dict[str, Any] | None

Create envelope using template with recipients

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

send_envelope_with_recipient_fields_async async

send_envelope_with_recipient_fields_async(input: DynamicRecipients, account_id: str, template_id: str, merge_roles_on_draft: Optional[str] = None, email_subject: Optional[str] = None) -> dict[str, Any] | None

Create envelope using template with recipients and tabs

Create envelope using template with recipients and tabs

send_draft_envelope_async async

send_draft_envelope_async(account_id: str, envelope_id: str) -> dict[str, Any] | None

Send envelope

Send an existing envelope.

get_envelope_custom_field_async async

get_envelope_custom_field_async(account_id: str, envelope_id: str, field_name: str) -> dict[str, Any] | None

Get envelope custom field info

Get envelope custom field info.

update_envelope_custom_field_async async

update_envelope_custom_field_async(account_id: str, envelope_id: str, field_id: str, field_type: str, name: str, value: str) -> dict[str, Any] | None

Update envelope custom field

Update value for the specified envelope custom field

generate_embedded_sender_url_async async

generate_embedded_sender_url_async(input: AdditionalURLForSenderView, account_id: str, envelope_id: str, open_in: str, return_url: str) -> dict[str, Any] | None

Generate Embedded Sender URL

Generate Embedded Sender URL

get_recipient_status_async async

get_recipient_status_async(account_id: str, envelope_id: str) -> dict[str, Any] | None

List recipients from an envelope

List recipients from an envelope

remove_recipient_from_envelope_async async

remove_recipient_from_envelope_async(account_id: str, envelope_id: str, folder_id: str, remove_recipient_from_envelope_recipient_id: str) -> dict[str, Any] | None

Remove recipient from an envelope

Remove recipient from an envelope

get_recipient_fields_async async

get_recipient_fields_async(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) -> dict[str, Any] | None

Get recipient info from envelope

Get recipient info from envelope

get_audit_events_async async

get_audit_events_async(account_id: str, envelope_id: str) -> dict[str, Any] | None

Get audit event list

Get audit event list

add_verification_to_recipient_async async

add_verification_to_recipient_async(input: AdditionalRecipientData, account_id: str, envelope_id: str, recipient_id: str, recipient_type: str, verification_type: str) -> dict[str, Any] | None

Add verification type to a recipient

Add verification type to a recipient.

update_envelope_recipient_async async

update_envelope_recipient_async(input: AdditionalRecipientParamsSchema, 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) -> dict[str, Any] | None

Update recipient on an envelope

Update recipient on an envelope

apply_templates_to_documents_async async

apply_templates_to_documents_async(input: ApplyTemplatesToDocumentsInput, account_id: str, envelope_id: str, template_id: str, preserve_template_recipient: Optional[str] = None) -> None

Apply a template to documents

Apply a template to documents

create_bulk_send_list_async async

create_bulk_send_list_async(input: CreateBulkSendListInput, account_id: str, name: str) -> dict[str, Any] | None

Create bulk send list

Create bulk send list

bulk_send_async async

bulk_send_async(account_id: str, bulk_send_list_id: str, envelope_or_template_id: str) -> dict[str, Any] | None

Bulk send envelope using template

Bulk send envelope using template

get_login_accounts_async async

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

Login

Login

get_envelope_templates_async async

get_envelope_templates_async(account_id: str) -> dict[str, Any] | None

List templates

List templates for a specific account.

add_documents_to_envelope_async async

add_documents_to_envelope_async(input: AddDocumentsToEnvelopeInput, account_id: str, envelope_id: str) -> dict[str, Any] | None

Add documents to an envelope

Add documents to an envelope.

list_template_documents_async async

list_template_documents_async(account_id: str, template_id: str) -> dict[str, Any] | None

List documents from a template

List documents from a template

list_envelope_documents_async async

list_envelope_documents_async(account_id: str, envelope_id: str) -> dict[str, Any] | None

List documents from an envelope

List documents from an envelope

get_envelope_document_info_async async

get_envelope_document_info_async(account_id: str, envelope_id: str, document_name: str) -> dict[str, Any] | None

Get document info from envelope

Get document info from envelope

get_tab_info_async async

get_tab_info_async(account_id: str, envelope_id: str, recipient_id: str, tab_label: str) -> dict[str, Any] | None

Get info for recipient tab

Returns the value of the tab for the given recipient

add_recipient_tabs_async async

add_recipient_tabs_async(input: AnchorTabSchema, account_id: str, envelope_id: str, recipient_id: str, tab_type: str) -> dict[str, Any] | None

Add tabs for a recipient on an envelope

Add tabs for a recipient on an envelope

update_recipient_tabs_values_async async

update_recipient_tabs_values_async(input: UpdateRecipientTabsValuesInput, account_id: str, envelope_id: str, recipient_id: str) -> None

Update recipient tab values on an envelope

Update recipient tab values on an envelope

get_envelope_recipient_tabs_async async

get_envelope_recipient_tabs_async(account_id: str, envelope_id: str, recipient_id: str) -> dict[str, Any] | None

Get recipient tabs from envelope

Get recipient tabs from envelope

trigger_maestro_flow_async async

trigger_maestro_flow_async(input: MaestroInputVariables, account_id: str, workflow_id: str, instance_name: str) -> dict[str, Any] | None

Start Docusign workflow

Start Docusign workflow

build_number_async async

build_number_async(input: BuildNumberSchema) -> dict[str, Any] | None

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

Identifier for the currently deployed build.

add_recipient_to_envelope_async async

add_recipient_to_envelope_async(input: AdditionalRecipientParamsSchema, 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) -> dict[str, Any] | None

Add recipient to an envelope

Add recipient to an envelope.

create_blank_envelope_async async

create_blank_envelope_async(input: CombinedEmailBodyAndCustomFields, account_id: str, email_subject: str) -> dict[str, Any] | None

Create envelope

Create a new blank envelope.

generate_embedded_signing_url_async async

generate_embedded_signing_url_async(input: DynamicSigningUrlFields, account_id: str, envelope_id: str, is_in_person_signer: str, authentication_method: str, return_url: str) -> dict[str, Any] | None

Generate Embedded Signing URL

Generate Embedded Signing URL

get_documents_async async

get_documents_async(account_id: str, envelope_id: str, document_id: str, language: Optional[str] = None) -> dict[str, Any] | None

Get documents from an envelope

Get documents from an envelope

get_organizations_async async

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

Get organizations

Get organizations

get_account_custom_fields_async async

get_account_custom_fields_async(account_id: str) -> None

Get account custom fields

Get the custom fields for a specified account.

get_folder_list_async async

get_folder_list_async(account_id: str) -> dict[str, Any] | None

List folders

List folders for a specific account.

get_folder_envelope_list_async async

get_folder_envelope_list_async(account_id: str, folder_id: str) -> dict[str, Any] | None

List envelopes

List envelopes under a particular folder.

static_response_for_recipient_types_async async

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

StaticResponseForRecipientTypes

Get recipient types.

static_response_for_signature_types_async async

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

StaticResponseForSignatureTypes

Get signature types.

get_signing_groups_async async

get_signing_groups_async(account_id: str) -> dict[str, Any] | None

GetSigningGroups

List signing groups for a specific account.

static_response_for_tab_types_async async

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

StaticResponseForTabTypes

Get tab types.

get_maestro_workflow_definitions_async async

get_maestro_workflow_definitions_async(account_id: str) -> dict[str, Any] | None

Get Maestro Workflow Definitions

Get Maestro Workflow Definitions

get_all_workflow_i_ds_async async

get_all_workflow_i_ds_async(account_id: str) -> dict[str, Any] | None

Get All Workflow Ids

Get All workflow ids

get_maestro_workflow_definition_async async

get_maestro_workflow_definition_async(account_id: str, workflow_id: str) -> dict[str, Any] | None

Get Maestro Workflow Definition

Get Maestro Workflow Definition

get_dynamic_signers_async async

get_dynamic_signers_async(account_id: str, template_id: str) -> dict[str, Any] | None

Get the signers of a template in dynamic schema format

Get the signers of a template in dynamic schema format.

get_dynamic_recipients_async async

get_dynamic_recipients_async(account_id: str, template_id: str) -> dict[str, Any] | None

Get the signers of a template in dynamic schema format

Get the signers of a template in dynamic schema format.

static_response_for_recipient_type_schema_async async

static_response_for_recipient_type_schema_async(recipient_type: str, signature_type: Optional[str] = None) -> dict[str, Any] | None

StaticResponseForRecipientTypeSchema

Get schema for a specific recipient type.

static_response_for_verification_type_schema_async async

static_response_for_verification_type_schema_async(verification_type: str) -> dict[str, Any] | None

StaticResponseForVerificationTypeSchema

Get schema for a verification type.

static_response_for_embedded_sender_schema_async async

static_response_for_embedded_sender_schema_async(return_url: str) -> dict[str, Any] | None

StaticResponseForEmbeddedSenderSchema

Get schema for return URL.

static_response_for_embedded_signing_schema_async async

static_response_for_embedded_signing_schema_async(return_url: str, is_in_person_signer: str) -> dict[str, Any] | None

StaticResponseForEmbeddedSigningSchema

Get schema for return URL.

static_response_for_build_number_schema_async async

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

StaticResponseForBuildNumberSchema

Get schema for a build number.

get_custom_fields_async async

get_custom_fields_async(account_id: str) -> None

Get custom fields from an account

Get custom fields from an account

static_response_for_anchor_tab_schema_async async

static_response_for_anchor_tab_schema_async(tab_type: str) -> dict[str, Any] | None

StaticResponseForAnchorTabSchema

Get schema for a specific anchor tab.

static_response_for_composite_templates_async async

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

StaticResponseForCompositeTemplates

Get schema for a composite templates.