DocuSignClient Class

Definition

Typed client for docusign connector.

public class DocuSignClient : Azure.Connectors.Sdk.ConnectorClientBase
type DocuSignClient = class
    inherit ConnectorClientBase
Public Class DocuSignClient
Inherits ConnectorClientBase
Inheritance
DocuSignClient

Constructors

Name Description
DocuSignClient()
DocuSignClient(String)

Creates a new DocuSignClient with the specified connection runtime URL string. Uses ManagedIdentityCredential by default.

DocuSignClient(Uri, TokenCredential, ConnectorClientOptions)

Creates a new DocuSignClient with the specified connection runtime URL and credential.

DocuSignClient(Uri, TokenCredential)

Creates a new DocuSignClient with the specified connection runtime URL and credential.

DocuSignClient(Uri)

Creates a new DocuSignClient with the specified connection runtime URL. Uses ManagedIdentityCredential by default.

Properties

Name Description
ConnectorName
Pipeline

Gets the HTTP pipeline for making connector requests.

(Inherited from ConnectorClientBase)

Methods

Name Description
AddDocumentsToEnvelopeAsync(String, String, AddDocumentsToEnvelopeInput, CancellationToken)

Add documents to an envelope

AddRecipientTabsAsync(String, String, String, AnchorTabSchema, String, CancellationToken)

Add tabs for a recipient on an envelope

AddRecipientToEnvelopeAsync(String, String, AdditionalRecipientParamsSchema, String, String, String, String, String, String, String, String, String, Nullable<Int32>, Nullable<Int32>, String, String, String, CancellationToken)

Add recipient to an envelope (V2)

AddRemindersAsync(String, String, Boolean, String, String, String, CancellationToken)

Add reminders for an envelope

AddVerificationToRecipientAsync(String, String, AdditionalRecipientData, String, String, String, CancellationToken)

Add verification type to a recipient

ApplyTemplatesToDocumentsAsync(String, String, ApplyTemplatesToDocumentsInput, String, String, CancellationToken)

Apply a template to documents

BuildNumberAsync(BuildNumberSchema, CancellationToken)

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

BulkSendAsync(String, String, String, CancellationToken)

Bulk send envelope using template

CallConnectorAsync(HttpMethod, String, Object, CancellationToken)

Sends a connector API request with no response body. Uses the Azure.Core HttpPipeline for retry, authentication, and diagnostics.

(Inherited from ConnectorClientBase)
CallConnectorAsync<TResponse>(HttpMethod, String, Object, CancellationToken)

Sends a connector API request and deserializes the JSON response. Uses the Azure.Core HttpPipeline for retry, authentication, and diagnostics.

(Inherited from ConnectorClientBase)
CompositeTemplatesAsync(String, CompositeTemplateSchema, String, String, String, CancellationToken)

Create envelope using composite templates

CreateBlankEnvelopeAsync(String, AccountCustomFields, String, String, CancellationToken)

Create envelope

CreateBulkSendListAsync(String, CreateBulkSendListInput, String, CancellationToken)

Create bulk send list

CreateEnvelopeFromTemplateAsync(String, AccountCustomFields, String, String, CancellationToken)

DEPRECATED: Create envelope using template

CreateEnvelopeFromTemplateNoRecipientsAsync(String, String, String, CancellationToken)

Create envelope using template

Dispose() (Inherited from ConnectorClientBase)
Dispose(Boolean)

Disposes the connector client resources.

(Inherited from ConnectorClientBase)
GenerateEmbeddedSenderURLAsync(String, String, AdditionalURLForSenderView, String, String, CancellationToken)

Generate Embedded Sender URL

GenerateEmbeddedSigningURLAsync(String, String, DynamicSigningUrlFields, String, String, String, CancellationToken)

Generate Embedded Signing URL (V2)

GetAccountCustomFieldsAsync(String, CancellationToken)

Get account custom fields

GetAllWorkflowIDsAsync(String, CancellationToken)

Get All Workflow Ids

GetAuditEventsAsync(String, String, CancellationToken)

Get audit event list

GetCustomFieldsAsync(String, CancellationToken)

Get custom fields from an account

GetDocgenFormFieldsAsync(String, String, CancellationToken)

Get document generation form fields from envelope

GetDocumentsAsync(String, String, String, CancellationToken)

Get documents from an envelope

GetDynamicRecipientsAsync(String, String, CancellationToken)

Get the signers of a template in dynamic schema format

GetDynamicSignersAsync(String, String, CancellationToken)

Get the signers of a template in dynamic schema format

GetEnvelopeCustomFieldAsync(String, String, String, CancellationToken)

Get custom field info from envelope

GetEnvelopeDocumentFieldsAsync(String, String, String, CancellationToken)

Get document custom fields from envelope

GetEnvelopeDocumentInfoAsync(String, String, String, CancellationToken)

Get document info from envelope

GetEnvelopeDocumentTabsAsync(String, String, String, CancellationToken)

Get document tabs from envelope

GetEnvelopeRecipientTabsAsync(String, String, String, CancellationToken)

Get recipient tabs from envelope

GetEnvelopeTemplatesAsync(String, CancellationToken)

List templates

GetFolderEnvelopeListAsync(String, String, CancellationToken)

List envelopes

GetFolderListAsync(String, CancellationToken)

List folders

GetLoginAccountsAsync(CancellationToken)

Login

GetMaestroWorkflowDefinitionAsync(String, String, CancellationToken)

Get Maestro Workflow Definition

GetMaestroWorkflowDefinitionsAsync(String, CancellationToken)

Get Maestro Workflow Definitions

GetRecipientFieldsAsync(String, String, String, String, String, String, CancellationToken)

Get recipient info from envelope

GetRecipientStatusAsync(String, String, String, CancellationToken)

List recipients from envelope

GetSigningGroupsAsync(String, CancellationToken)

GetSigningGroups

GetTabInfoAsync(String, String, String, String, CancellationToken)

Get info for recipient tab

GetTemplateDocumentTabsAsync(String, String, String, CancellationToken)

Get document tabs from template

ListEnvelopeDocumentsAsync(String, String, CancellationToken)

List documents from an envelope

ListEnvelopesAsync(String, String, String, String, String, String, String, String, Nullable<Int32>, Nullable<Int32>, String, String, CancellationToken)

Copilot: List envelopes

ListTemplateDocumentsAsync(String, String, CancellationToken)

List documents from a template

RemoveRecipientFromEnvelopeAsync(String, String, String, String, CancellationToken)

Remove recipient from an envelope

ResendEnvelopeAsync(String, CancellationToken)

Resend the envelope

ResolveUrl(String)

Resolves a relative path or validates an absolute URL against the connection runtime URL. When the NextLink host matches the connection URL, it's used as-is. When it doesn't match (codeless connectors like ARM return nextLink pointing to the backend host e.g. management.azure.com), the path+query is extracted and routed through the APIM proxy. This is safe because the request still goes through the connection runtime URL with API Hub auth.

(Inherited from ConnectorClientBase)
SalesCopilotListEnvelopesAsync(String, String, String, String, String, String, String, String, Nullable<Int32>, Nullable<Int32>, String, String, CancellationToken)

Copilot for Sales: List envelopes

ScpGetEmailSummaryAsync(String, String, String, String, String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

Copilot for Sales: Get email summary

ScpGetKeySalesAsync(String, String, String, Nullable<Int32>, Nullable<Int32>, String, String, CancellationToken)

Copilot for Sales: Get key sales

ScpGetRelatedActivitiesAsync(String, String, String, String, Nullable<Int32>, Nullable<Int32>, String, String, CancellationToken)

Copilot: Get related activities

ScpGetRelatedRecordsAsync(String, String, String, Nullable<Int32>, Nullable<Int32>, String, String, CancellationToken)

Copilot: Get related records

SearchListEnvelopesAsync(String, String, String, String, String, String, String, String, String, Nullable<Int32>, Nullable<Int32>, String, String, CancellationToken)

List envelopes

SendDraftEnvelopeAsync(String, String, CancellationToken)

Send envelope

SendEnvelopeAsync(String, DynamicSigners, String, String, String, String, CancellationToken)

DEPRECATED: Create envelope using template with recipients

SendEnvelopeWithRecipientFieldsAsync(String, DynamicRecipients, String, String, CancellationToken)

Create envelope using template with recipients and tabs

StaticResponseForAnchorTabSchemaAsync(String, CancellationToken)

StaticResponseForAnchorTabSchema

StaticResponseForBuildNumberSchemaAsync(CancellationToken)

StaticResponseForBuildNumberSchema

StaticResponseForCompositeTemplatesAsync(CancellationToken)

StaticResponseForCompositeTemplates

StaticResponseForEmbeddedSenderSchemaAsync(String, CancellationToken)

StaticResponseForEmbeddedSenderSchema

StaticResponseForEmbeddedSigningSchemaAsync(String, String, CancellationToken)

StaticResponseForEmbeddedSigningSchemaV2

StaticResponseForRecipientTypesAsync(CancellationToken)

StaticResponseForRecipientTypes

StaticResponseForRecipientTypeSchemaAsync(String, String, CancellationToken)

StaticResponseForRecipientTypeSchema

StaticResponseForSignatureTypesAsync(CancellationToken)

StaticResponseForSignatureTypes

StaticResponseForTabTypesAsync(CancellationToken)

StaticResponseForTabTypes

StaticResponseForVerificationTypeSchemaAsync(String, CancellationToken)

StaticResponseForVerificationTypeSchema

TriggerMaestroFlowAsync(String, String, MaestroInputVariables, String, CancellationToken)

Start Docusign Maestro workflow

UpdateDocgenFormFieldsAsync(String, String, List<Nullable<JsonElement>>, String, CancellationToken)

Update document generation form fields from envelope

UpdateEnvelopeCustomFieldAsync(String, String, String, String, String, String, CancellationToken)

Update envelope custom field

UpdateEnvelopePrefillTabsAsync(String, String, String, List<Nullable<JsonElement>>, CancellationToken)

Update envelope prefill tabs

UpdateEnvelopeRecipientAsync(String, String, AdditionalRecipientParamsSchema, String, String, String, String, String, String, String, String, String, String, String, Nullable<Int32>, Nullable<Int32>, String, CancellationToken)

Update recipient on an envelope

UpdateRecipientTabsValuesAsync(String, String, String, List<Nullable<JsonElement>>, CancellationToken)

Update recipient tab values on an envelope

VoidEnvelopeAsync(String, String, String, CancellationToken)

Void the envelope

Applies to