Show / Hide Table of Contents

Class DocumentClient

Represents a collection of functions to interact with the API endpoints. The functions perform actions such as sending document to sign, getting document list, deleting a document, downloading audit log, downloading a document, changing access code of the desired signer and so on.

Inheritance
System.Object
DocumentClient
Implements
IDocumentClient
IApiAccessor
Namespace: BoldSign.Api
Assembly: BoldSign.Api.dll
Syntax
public class DocumentClient : object, IDocumentClient, IApiAccessor

Constructors

| Improve this Doc View Source

DocumentClient()

Initializes a new instance of the DocumentClient class.

Declaration
public DocumentClient()
| Improve this Doc View Source

DocumentClient(ApiClient)

Initializes a new instance of the class using Configuration object.

Declaration
public DocumentClient(ApiClient apiClient)
Parameters
Type Name Description
ApiClient apiClient

An instance of ApiClient

| Improve this Doc View Source

DocumentClient(Configuration)

Initializes a new instance of the DocumentClient class using Configuration object.

Declaration
public DocumentClient(Configuration configuration = null)
Parameters
Type Name Description
Configuration configuration

An instance of Configuration

| Improve this Doc View Source

DocumentClient(String)

Initializes a new instance of the DocumentClient class.

Declaration
public DocumentClient(string basePath)
Parameters
Type Name Description
System.String basePath

Properties

| Improve this Doc View Source

Configuration

Gets or sets the configuration object.

Declaration
public Configuration Configuration { get; set; }
Property Value
Type Description
Configuration

An instance of the Configuration

| Improve this Doc View Source

ExceptionFactory

Provides a factory method hook for the creation of exceptions.

Declaration
public ExceptionFactory ExceptionFactory { get; set; }
Property Value
Type Description
ExceptionFactory

Methods

| Improve this Doc View Source

AddAuthentication(String, String, AuthenticationType, Nullable<Int32>, String)

Add Authentication to user.

Declaration
public void AddAuthentication(string documentId, string emailId, AuthenticationType authenticationType, int? signerOrder = null, string newAccessCode = "")
Parameters
Type Name Description
System.String documentId

DocumentId.

System.String emailId

EmailID.

AuthenticationType authenticationType

AuthenticationType.

System.Nullable<System.Int32> signerOrder

SignerOrder.

System.String newAccessCode

NewAccesscode.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call.

| Improve this Doc View Source

AddAuthenticationAsync(String, String, AuthenticationType, Nullable<Int32>, String)

Add Authentication to user.

Declaration
public async Task AddAuthenticationAsync(string documentId, string emailId, AuthenticationType authenticationType, int? signerOrder = null, string newAccessCode = "")
Parameters
Type Name Description
System.String documentId

DocumentId.

System.String emailId

EmailID.

AuthenticationType authenticationType

AuthenticationType.

System.Nullable<System.Int32> signerOrder

SignerOrder.

System.String newAccessCode

NewAccesscode.

Returns
Type Description
Task

AddAuthentication.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call.

| Improve this Doc View Source

AddAuthenticationAsyncWithHttpInfo(String, String, AuthenticationType, Nullable<Int32>, String)

Add Authentication to user.

Declaration
public async Task<ApiResponse<object>> AddAuthenticationAsyncWithHttpInfo(string documentId, string emailId, AuthenticationType authenticationType, int? signerOrder = null, string newAccessCode = "")
Parameters
Type Name Description
System.String documentId

DocumentId.

System.String emailId

EmailID.

AuthenticationType authenticationType

AuthenticationType.

System.Nullable<System.Int32> signerOrder

SignerOrder.

System.String newAccessCode

NewAccesscode.

Returns
Type Description
Task<ApiResponse<System.Object>>

ApiResponse of Object(AddAuthentication).

Exceptions
Type Condition
ApiException

Thrown when fails to make API call.

| Improve this Doc View Source

AddAuthenticationWithHttpInfo(String, String, AuthenticationType, Nullable<Int32>, String)

Add Authentication to user.

Declaration
public ApiResponse<object> AddAuthenticationWithHttpInfo(string documentId, string emailId, AuthenticationType authenticationType, int? signerOrder = null, string newAccessCode = "")
Parameters
Type Name Description
System.String documentId

DocumentId.

System.String emailId

EmailID.

AuthenticationType authenticationType

AuthenticationType.

System.Nullable<System.Int32> signerOrder

SignerOrder.

System.String newAccessCode

NewAccesscode.

Returns
Type Description
ApiResponse<System.Object>

ApiResponse of Object(void).

Exceptions
Type Condition
ApiException

Thrown when fails to make API call.

| Improve this Doc View Source

AddTag(DocumentTags)

Delete the document when a particular document’s ID is given as input.

Declaration
public void AddTag(DocumentTags addTags)
Parameters
Type Name Description
DocumentTags addTags

contains DocumentId and Label Parameter.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call.

| Improve this Doc View Source

AddTagAsync(DocumentTags)

Add the Tag to the document when a particular document’s ID and TagNames are given as input.

Declaration
public async Task AddTagAsync(DocumentTags addTags)
Parameters
Type Name Description
DocumentTags addTags

contains DocumentId and Label Parameter.

Returns
Type Description
Task

Task of void.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call.

| Improve this Doc View Source

AddTagAsyncWithHttpInfo(DocumentTags)

Adding the document's Label when a particular document’s ID and Tag Name is given as input.

Declaration
public Task<ApiResponse<object>> AddTagAsyncWithHttpInfo(DocumentTags addTags)
Parameters
Type Name Description
DocumentTags addTags

contains DocumentId and Label Parameter.

Returns
Type Description
Task<ApiResponse<System.Object>>

ApiResponse of Object(void).

Exceptions
Type Condition
ApiException

Thrown when fails to make API call.

| Improve this Doc View Source

AddTagWithHttpInfo(DocumentTags)

Adding the document's Label when a particular document’s ID and Tag Name is given as input.

Declaration
public ApiResponse<object> AddTagWithHttpInfo(DocumentTags addTags)
Parameters
Type Name Description
DocumentTags addTags

contains DocumentId and Label Parameter.

Returns
Type Description
ApiResponse<System.Object>

ApiResponse of Object(void).

Exceptions
Type Condition
ApiException

Thrown when fails to make API call.

| Improve this Doc View Source

ChangeAccessCode(String, String, String, Nullable<Int32>)

Changes the access code for the desired document signer by verifying the email ID of the signer.

Declaration
public void ChangeAccessCode(string documentId, string emailId, string newAccessCode, int? signerOrder = null)
Parameters
Type Name Description
System.String documentId

Gets or sets the document id.

System.String emailId

Gets or sets the signer email.

System.String newAccessCode

The new access code.

System.Nullable<System.Int32> signerOrder

Gets or sets the signer's order. When signer order is enabled for a document, this order is used to target that particular order with given signer email. (optional)

Exceptions
Type Condition
ApiException

Thrown when fails to make API call

| Improve this Doc View Source

ChangeAccessCodeAsync(String, String, String, Nullable<Int32>)

Changes the access code for the desired document signer by verifying the email ID of the signer.

Declaration
public async Task ChangeAccessCodeAsync(string documentId, string emailId, string newAccessCode, int? signerOrder = null)
Parameters
Type Name Description
System.String documentId

Gets or sets the document id.

System.String emailId

Gets or sets the signer email.

System.String newAccessCode

The new access code.

System.Nullable<System.Int32> signerOrder

Gets or sets the signer's order. When signer order is enabled for a document, this order is used to target that particular order with given signer email. (optional)

Returns
Type Description
Task

Task of void

Exceptions
Type Condition
ApiException

Thrown when fails to make API call

| Improve this Doc View Source

ChangeAccessCodeAsyncWithHttpInfo(String, String, String, Nullable<Int32>)

Changes the access code for the desired document signer by verifying the email ID of the signer.

Declaration
public async Task<ApiResponse<object>> ChangeAccessCodeAsyncWithHttpInfo(string documentId, string emailId, string newAccessCode, int? signerOrder = null)
Parameters
Type Name Description
System.String documentId

Gets or sets the document id.

System.String emailId

Gets or sets the signer email.

System.String newAccessCode

The new access code.

System.Nullable<System.Int32> signerOrder

Gets or sets the signer's order. When signer order is enabled for a document, this order is used to target that particular order with given signer email. (optional)

Returns
Type Description
Task<ApiResponse<System.Object>>

Task of ApiResponse

Exceptions
Type Condition
ApiException

Thrown when fails to make API call

| Improve this Doc View Source

ChangeAccessCodeWithHttpInfo(String, String, String, Nullable<Int32>)

Changes the access code for the desired document signer by verifying the email ID of the signer.

Declaration
public ApiResponse<object> ChangeAccessCodeWithHttpInfo(string documentId, string emailId, string newAccessCode, int? signerOrder = null)
Parameters
Type Name Description
System.String documentId

Gets or sets the document id.

System.String emailId

Gets or sets the signer email.

System.String newAccessCode

The new access code.

System.Nullable<System.Int32> signerOrder

Gets or sets the signer's order. When signer order is enabled for a document, this order is used to target that particular order with given signer email. (optional)

Returns
Type Description
ApiResponse<System.Object>

ApiResponse of Object(void)

Exceptions
Type Condition
ApiException

Thrown when fails to make API call

| Improve this Doc View Source

ChangeRecipient(String, String, String, String, String, Nullable<Int32>)

Change recipient details of a document.

Declaration
public void ChangeRecipient(string documentId, string oldSignerEmail, string reason, string newSignerName, string newSignerEmail, int? signerOrder = null)
Parameters
Type Name Description
System.String documentId

The document id.

System.String oldSignerEmail

The signer email.

System.String reason

The reason for changing recipient details.

System.String newSignerName

The new name of the recipient.

System.String newSignerEmail

The new email address of recipient.

System.Nullable<System.Int32> signerOrder

The signer order.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call.

| Improve this Doc View Source

ChangeRecipientasync(String, String, String, String, String, Nullable<Int32>)

Change recipient details of a document.

Declaration
public async Task ChangeRecipientasync(string documentId, string oldSignerEmail, string reason, string newSignerName, string newSignerEmail, int? signerOrder = null)
Parameters
Type Name Description
System.String documentId

The document id.

System.String oldSignerEmail

The signer email.

System.String reason

The reason for changing recipient details.

System.String newSignerName

The new name of the recipient .

System.String newSignerEmail

The new email address of recipient .

System.Nullable<System.Int32> signerOrder

The signer order.

Returns
Type Description
Task

A representing the asynchronous operation.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call.

| Improve this Doc View Source

ChangeRecipientasyncWithHttpInfo(String, String, String, String, String, Nullable<Int32>)

Change recipient details of a document.

Declaration
public async Task<ApiResponse<object>> ChangeRecipientasyncWithHttpInfo(string documentId, string oldSignerEmail, string reason, string newSignerName, string newSignerEmail, int? signerOrder = null)
Parameters
Type Name Description
System.String documentId

The document id.

System.String oldSignerEmail

The signer email.

System.String reason

The reason for changing recipient details.

System.String newSignerName

The new name of the recipient .

System.String newSignerEmail

The new email address of recipient .

System.Nullable<System.Int32> signerOrder

The signer order.

Returns
Type Description
Task<ApiResponse<System.Object>>

ApiResponse of Object(void).

Exceptions
Type Condition
ApiException

Thrown when fails to make API call.

| Improve this Doc View Source

ChangeRecipientWithHttpInfo(String, String, String, String, String, Nullable<Int32>)

Change recipient details of a document.

Declaration
public ApiResponse<object> ChangeRecipientWithHttpInfo(string documentId, string oldSignerEmail, string reason, string newSignerName, string newSignerEmail, int? signerOrder = null)
Parameters
Type Name Description
System.String documentId

The document id.

System.String oldSignerEmail

The signer email.

System.String reason

The reason for changing recipient details.

System.String newSignerName

The new name of the recipient.

System.String newSignerEmail

The new email address of recipient.

System.Nullable<System.Int32> signerOrder

The signer order.

Returns
Type Description
ApiResponse<System.Object>

ApiResponse of Object(void).

Exceptions
Type Condition
ApiException

Thrown when fails to make API call.

| Improve this Doc View Source

CreateEmbeddedRequestUrl(EmbeddedDocumentRequest)

Embedded sends the document and generates a URL to embedded that document into iframe.

Declaration
public EmbeddedSendCreated CreateEmbeddedRequestUrl(EmbeddedDocumentRequest sendRequest)
Parameters
Type Name Description
EmbeddedDocumentRequest sendRequest

The signRequestDetails.

Returns
Type Description
EmbeddedSendCreated

EmbeddedSendCreated.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call.

| Improve this Doc View Source

CreateEmbeddedRequestUrlAsync(EmbeddedDocumentRequest)

Generates a send URL which embeds document sending process into your application.

Declaration
public async Task<EmbeddedSendCreated> CreateEmbeddedRequestUrlAsync(EmbeddedDocumentRequest sendRequest)
Parameters
Type Name Description
EmbeddedDocumentRequest sendRequest

The signRequestDetails.

Returns
Type Description
Task<EmbeddedSendCreated>

Task of EmbeddedSendCreated.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call.

| Improve this Doc View Source

CreateEmbeddedRequestUrlAsyncWithHttpInfo(EmbeddedDocumentRequest)

Embedded sends the document and generates a URL to embedded that document into iframe.

Declaration
public async Task<ApiResponse<EmbeddedSendCreated>> CreateEmbeddedRequestUrlAsyncWithHttpInfo(EmbeddedDocumentRequest sendRequest)
Parameters
Type Name Description
EmbeddedDocumentRequest sendRequest

The signRequestDetails.

Returns
Type Description
Task<ApiResponse<EmbeddedSendCreated>>

Task of ApiResponse (EmbeddedSendCreated).

Exceptions
Type Condition
ApiException

Thrown when fails to make API call.

| Improve this Doc View Source

CreateEmbeddedRequestUrlWithHttpInfo(EmbeddedDocumentRequest)

Embedded sends the document and generates a URL to embedded that document into iframe.

Declaration
public ApiResponse<EmbeddedSendCreated> CreateEmbeddedRequestUrlWithHttpInfo(EmbeddedDocumentRequest sendRequest)
Parameters
Type Name Description
EmbeddedDocumentRequest sendRequest

The signRequestDetails.

Returns
Type Description
ApiResponse<EmbeddedSendCreated>

ApiResponse of EmbeddedSendCreated.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call.

| Improve this Doc View Source

DeleteDocument(String)

Delete the document when a particular document’s ID is given as input.

Declaration
public void DeleteDocument(string documentId)
Parameters
Type Name Description
System.String documentId

Document Id.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call

| Improve this Doc View Source

DeleteDocumentAsync(String)

Delete the document when a particular document’s ID is given as input.

Declaration
public async Task DeleteDocumentAsync(string documentId)
Parameters
Type Name Description
System.String documentId

Document Id.

Returns
Type Description
Task

Task of void

Exceptions
Type Condition
ApiException

Thrown when fails to make API call

| Improve this Doc View Source

DeleteDocumentAsyncWithHttpInfo(String)

Delete the document when a particular document’s ID is given as input.

Declaration
public async Task<ApiResponse<object>> DeleteDocumentAsyncWithHttpInfo(string documentId)
Parameters
Type Name Description
System.String documentId

Document Id.

Returns
Type Description
Task<ApiResponse<System.Object>>

Task of ApiResponse

Exceptions
Type Condition
ApiException

Thrown when fails to make API call

| Improve this Doc View Source

DeleteDocumentWithHttpInfo(String)

Delete the document when a particular document’s ID is given as input.

Declaration
public ApiResponse<object> DeleteDocumentWithHttpInfo(string documentId)
Parameters
Type Name Description
System.String documentId

Document Id.

Returns
Type Description
ApiResponse<System.Object>

ApiResponse of Object(void)

Exceptions
Type Condition
ApiException

Thrown when fails to make API call

| Improve this Doc View Source

DeleteTag(DocumentTags)

Delete the document's Tag when a particular document’s ID and Tags Names is given as input.

Declaration
public void DeleteTag(DocumentTags deleteTags)
Parameters
Type Name Description
DocumentTags deleteTags

contains DocumentId and Label Parameter.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call.

| Improve this Doc View Source

DeleteTagAsync(DocumentTags)

Delete the document when a particular document’s ID is given as input.

Declaration
public async Task DeleteTagAsync(DocumentTags deleteTags)
Parameters
Type Name Description
DocumentTags deleteTags

contains DocumentId and Label Parameter.

Returns
Type Description
Task

ApiResponse of Object(void).

Exceptions
Type Condition
ApiException

Thrown when fails to make API call.

| Improve this Doc View Source

DeleteTagAsyncWithHttpInfo(DocumentTags)

Adding the document's Label when a particular document’s ID and Tag Name is given as input.

Declaration
public Task<ApiResponse<object>> DeleteTagAsyncWithHttpInfo(DocumentTags deleteTags)
Parameters
Type Name Description
DocumentTags deleteTags

contains DocumentId and Label Parameter.

Returns
Type Description
Task<ApiResponse<System.Object>>

ApiResponse of Object(void).

Exceptions
Type Condition
ApiException

Thrown when fails to make API call.

| Improve this Doc View Source

DeleteTagWithHttpInfo(DocumentTags)

Delete the document when a particular document’s ID is given as input.

Declaration
public ApiResponse<object> DeleteTagWithHttpInfo(DocumentTags deleteTags)
Parameters
Type Name Description
DocumentTags deleteTags

contains DocumentId and Label Parameter.

Returns
Type Description
ApiResponse<System.Object>

ApiResponse of Object(void).

Exceptions
Type Condition
ApiException

Thrown when fails to make API call.

| Improve this Doc View Source

DownloadAuditLog(String)

Download the audit trail document for a particular document with given document ID.

Declaration
public Stream DownloadAuditLog(string documentId)
Parameters
Type Name Description
System.String documentId

Document Id.

Returns
Type Description
Stream

System.IO.Stream

Exceptions
Type Condition
ApiException

Thrown when fails to make API call

| Improve this Doc View Source

DownloadAuditLogAsync(String)

Download the audit trail document for a particular document with given document ID.

Declaration
public async Task<Stream> DownloadAuditLogAsync(string documentId)
Parameters
Type Name Description
System.String documentId

Document Id.

Returns
Type Description
Task<Stream>

Task of System.IO.Stream

Exceptions
Type Condition
ApiException

Thrown when fails to make API call

| Improve this Doc View Source

DownloadAuditLogAsyncWithHttpInfo(String)

Download the audit trail document for a particular document with given document ID.

Declaration
public async Task<ApiResponse<Stream>> DownloadAuditLogAsyncWithHttpInfo(string documentId)
Parameters
Type Name Description
System.String documentId

Document Id.

Returns
Type Description
Task<ApiResponse<Stream>>

Task of ApiResponse (System.IO.Stream)

Exceptions
Type Condition
ApiException

Thrown when fails to make API call

| Improve this Doc View Source

DownloadAuditLogWithHttpInfo(String)

Download the audit trail document for a particular document with given document ID.

Declaration
public ApiResponse<Stream> DownloadAuditLogWithHttpInfo(string documentId)
Parameters
Type Name Description
System.String documentId

Document Id.

Returns
Type Description
ApiResponse<Stream>

ApiResponse of System.IO.Stream

Exceptions
Type Condition
ApiException

Thrown when fails to make API call

| Improve this Doc View Source

DownloadDocument(String)

Download the document for given document ID.

Declaration
public Stream DownloadDocument(string documentId)
Parameters
Type Name Description
System.String documentId

Document Id.

Returns
Type Description
Stream

System.IO.Stream

Exceptions
Type Condition
ApiException

Thrown when fails to make API call

| Improve this Doc View Source

DownloadDocumentAsync(String)

Download the document for given document ID.

Declaration
public async Task<Stream> DownloadDocumentAsync(string documentId)
Parameters
Type Name Description
System.String documentId

Document Id.

Returns
Type Description
Task<Stream>

Task of System.IO.Stream

Exceptions
Type Condition
ApiException

Thrown when fails to make API call

| Improve this Doc View Source

DownloadDocumentAsyncWithHttpInfo(String)

Download the document for given document ID.

Declaration
public async Task<ApiResponse<Stream>> DownloadDocumentAsyncWithHttpInfo(string documentId)
Parameters
Type Name Description
System.String documentId

Document Id.

Returns
Type Description
Task<ApiResponse<Stream>>

Task of ApiResponse (System.IO.Stream)

Exceptions
Type Condition
ApiException

Thrown when fails to make API call

| Improve this Doc View Source

DownloadDocumentWithHttpInfo(String)

Download the document for given document ID.

Declaration
public ApiResponse<Stream> DownloadDocumentWithHttpInfo(string documentId)
Parameters
Type Name Description
System.String documentId

Document Id.

Returns
Type Description
ApiResponse<Stream>

ApiResponse of System.IO.Stream

Exceptions
Type Condition
ApiException

Thrown when fails to make API call

| Improve this Doc View Source

GetBasePath()

Gets the base path of the API client.

Declaration
public string GetBasePath()
Returns
Type Description
System.String

The base path

| Improve this Doc View Source

GetEmbeddedSignLink(String, String, Nullable<DateTime>, String)

Get sign link in a mail for Embedded Sign to given Email ID. The link has expiry time. This method can also be used to send a redirect URL.

Declaration
public EmbeddedSigningLink GetEmbeddedSignLink(string documentId, string signerEmail, DateTime? signLinkValidTill = null, string redirectUrl = null)
Parameters
Type Name Description
System.String documentId

Gets or sets Document Id.

System.String signerEmail

Gets or sets signer email.

System.Nullable<DateTime> signLinkValidTill

Gets or sets sign link expiration date (Valid Till). (optional)

System.String redirectUrl

Gets or sets Redirect URL. (optional)

Returns
Type Description
EmbeddedSigningLink

EmbeddedSigningLink

Exceptions
Type Condition
ApiException

Thrown when fails to make API call

| Improve this Doc View Source

GetEmbeddedSignLinkAsync(String, String, Nullable<DateTime>, String)

Get sign link in a mail for Embedded Sign to given Email ID. The link has expiry time. This method can also be used to send a redirect URL.

Declaration
public async Task<EmbeddedSigningLink> GetEmbeddedSignLinkAsync(string documentId, string signerEmail, DateTime? signLinkValidTill = null, string redirectUrl = null)
Parameters
Type Name Description
System.String documentId

Gets or sets Document Id.

System.String signerEmail

Gets or sets signer email.

System.Nullable<DateTime> signLinkValidTill

Gets or sets sign link expiration date (Valid Till). (optional)

System.String redirectUrl

Gets or sets Redirect URL. (optional)

Returns
Type Description
Task<EmbeddedSigningLink>

Task of EmbeddedSigningLink

Exceptions
Type Condition
ApiException

Thrown when fails to make API call

| Improve this Doc View Source

GetEmbeddedSignLinkAsyncWithHttpInfo(String, String, Nullable<DateTime>, String)

Get sign link in a mail for Embedded Sign to given Email ID. The link has expiry time. This method can also be used to send a redirect URL.

Declaration
public async Task<ApiResponse<EmbeddedSigningLink>> GetEmbeddedSignLinkAsyncWithHttpInfo(string documentId, string signerEmail, DateTime? signLinkValidTill = null, string redirectUrl = null)
Parameters
Type Name Description
System.String documentId

Gets or sets Document Id.

System.String signerEmail

Gets or sets signer email.

System.Nullable<DateTime> signLinkValidTill

Gets or sets sign link expiration date (Valid Till). (optional)

System.String redirectUrl

Gets or sets Redirect URL. (optional)

Returns
Type Description
Task<ApiResponse<EmbeddedSigningLink>>

Task of ApiResponse (EmbeddedSigningLink)

Exceptions
Type Condition
ApiException

Thrown when fails to make API call

| Improve this Doc View Source

GetEmbeddedSignLinkWithHttpInfo(String, String, Nullable<DateTime>, String)

Get sign link in a mail for Embedded Sign to given Email ID. The link has expiry time. This method can also be used to send a redirect URL.

Declaration
public ApiResponse<EmbeddedSigningLink> GetEmbeddedSignLinkWithHttpInfo(string documentId, string signerEmail, DateTime? signLinkValidTill = null, string redirectUrl = null)
Parameters
Type Name Description
System.String documentId

Gets or sets Document Id.

System.String signerEmail

Gets or sets signer email.

System.Nullable<DateTime> signLinkValidTill

Gets or sets sign link expiration date (Valid Till). (optional)

System.String redirectUrl

Gets or sets Redirect URL. (optional)

Returns
Type Description
ApiResponse<EmbeddedSigningLink>

ApiResponse of EmbeddedSigningLink

Exceptions
Type Condition
ApiException

Thrown when fails to make API call

| Improve this Doc View Source

GetProperties(String)

Get summary of the document for the given document ID.

Declaration
public DocumentProperties GetProperties(string documentId)
Parameters
Type Name Description
System.String documentId

Document Id.

Returns
Type Description
DocumentProperties

DocumentProperties

Exceptions
Type Condition
ApiException

Thrown when fails to make API call

| Improve this Doc View Source

GetPropertiesAsync(String)

Get summary of the document for the given document ID.

Declaration
public async Task<DocumentProperties> GetPropertiesAsync(string documentId)
Parameters
Type Name Description
System.String documentId

Document Id.

Returns
Type Description
Task<DocumentProperties>

Task of DocumentProperties

Exceptions
Type Condition
ApiException

Thrown when fails to make API call

| Improve this Doc View Source

GetPropertiesAsyncWithHttpInfo(String)

Get summary of the document for the given document ID.

Declaration
public async Task<ApiResponse<DocumentProperties>> GetPropertiesAsyncWithHttpInfo(string documentId)
Parameters
Type Name Description
System.String documentId

Document Id.

Returns
Type Description
Task<ApiResponse<DocumentProperties>>

Task of ApiResponse (DocumentProperties)

Exceptions
Type Condition
ApiException

Thrown when fails to make API call

| Improve this Doc View Source

GetPropertiesWithHttpInfo(String)

Get summary of the document for the given document ID.

Declaration
public ApiResponse<DocumentProperties> GetPropertiesWithHttpInfo(string documentId)
Parameters
Type Name Description
System.String documentId

Document Id.

Returns
Type Description
ApiResponse<DocumentProperties>

ApiResponse of DocumentProperties

Exceptions
Type Condition
ApiException

Thrown when fails to make API call

| Improve this Doc View Source

ListDocuments(Int32, Nullable<Int32>, List<String>, List<String>, Nullable<DateTime>, List<Status>, Nullable<DateTime>, String, List<String>, Nullable<TransmitType>)

List all user documents which can be filtered by date, time, sender, status, and so on.

Declaration
public DocumentRecords ListDocuments(int page, int? pageSize = null, List<string> sentBy = null, List<string> recipients = null, DateTime? startDate = null, List<Status> status = null, DateTime? endDate = null, string searchKey = null, List<string> labels = null, TransmitType? transmitType = null)
Parameters
Type Name Description
System.Int32 page

Gets or sets the page.

System.Nullable<System.Int32> pageSize

Gets or sets the page size. (optional, default to 10)

List<System.String> sentBy

Gets or sets the documentId. (optional)

List<System.String> recipients

Gets or sets the recipients. (optional)

System.Nullable<DateTime> startDate

Gets or sets the start date. (optional)

List<Status> status

Gets or sets the status. (optional)

System.Nullable<DateTime> endDate

Gets or sets the endDate. (optional)

System.String searchKey

Gets or sets the searchKey. (optional)

List<System.String> labels
System.Nullable<TransmitType> transmitType
Returns
Type Description
DocumentRecords

DocumentRecords

Exceptions
Type Condition
ApiException

Thrown when fails to make API call

| Improve this Doc View Source

ListDocumentsAsync(Int32, Nullable<Int32>, List<String>, List<String>, Nullable<DateTime>, List<Status>, Nullable<DateTime>, String, List<String>, Nullable<TransmitType>)

List all user documents which can be filtered by date, time, sender, status, and so on.

Declaration
public async Task<DocumentRecords> ListDocumentsAsync(int page, int? pageSize = null, List<string> sentBy = null, List<string> recipients = null, DateTime? startDate = null, List<Status> status = null, DateTime? endDate = null, string searchKey = null, List<string> labels = null, TransmitType? transmitType = null)
Parameters
Type Name Description
System.Int32 page

Gets or sets the page.

System.Nullable<System.Int32> pageSize

Gets or sets the page size. (optional, default to 10)

List<System.String> sentBy

Gets or sets the documentId. (optional)

List<System.String> recipients

Gets or sets the recipients. (optional)

System.Nullable<DateTime> startDate

Gets or sets the start date. (optional)

List<Status> status

Gets or sets the status. (optional)

System.Nullable<DateTime> endDate

Gets or sets the endDate. (optional)

System.String searchKey

Gets or sets the searchKey. (optional)

List<System.String> labels
System.Nullable<TransmitType> transmitType
Returns
Type Description
Task<DocumentRecords>

Task of DocumentRecords

Exceptions
Type Condition
ApiException

Thrown when fails to make API call

| Improve this Doc View Source

ListDocumentsAsyncWithHttpInfo(Int32, Nullable<Int32>, List<String>, List<String>, Nullable<DateTime>, List<Status>, Nullable<DateTime>, String, List<String>, Nullable<TransmitType>)

List all user documents which can be filtered by date, time, sender, status, and so on.

Declaration
public async Task<ApiResponse<DocumentRecords>> ListDocumentsAsyncWithHttpInfo(int page, int? pageSize = null, List<string> sentBy = null, List<string> recipients = null, DateTime? startDate = null, List<Status> status = null, DateTime? endDate = null, string searchKey = null, List<string> labels = null, TransmitType? transmitType = null)
Parameters
Type Name Description
System.Int32 page

Gets or sets the page.

System.Nullable<System.Int32> pageSize

Gets or sets the page size. (optional, default to 10)

List<System.String> sentBy

Gets or sets the documentId. (optional)

List<System.String> recipients

Gets or sets the recipients. (optional)

System.Nullable<DateTime> startDate

Gets or sets the start date. (optional)

List<Status> status

Gets or sets the status. (optional)

System.Nullable<DateTime> endDate

Gets or sets the endDate. (optional)

System.String searchKey

Gets or sets the searchKey. (optional)

List<System.String> labels
System.Nullable<TransmitType> transmitType
Returns
Type Description
Task<ApiResponse<DocumentRecords>>

Task of ApiResponse (DocumentRecords)

Exceptions
Type Condition
ApiException

Thrown when fails to make API call

| Improve this Doc View Source

ListDocumentsWithHttpInfo(Int32, Nullable<Int32>, List<String>, List<String>, Nullable<DateTime>, List<Status>, Nullable<DateTime>, String, List<String>, Nullable<TransmitType>)

List all user documents which can be filtered by date, time, sender, status, and so on.

Declaration
public ApiResponse<DocumentRecords> ListDocumentsWithHttpInfo(int page, int? pageSize = null, List<string> sentBy = null, List<string> recipients = null, DateTime? startDate = null, List<Status> status = null, DateTime? endDate = null, string searchKey = null, List<string> labels = null, TransmitType? transmitType = null)
Parameters
Type Name Description
System.Int32 page

Gets or sets the page.

System.Nullable<System.Int32> pageSize

Gets or sets the page size. (optional, default to 10)

List<System.String> sentBy

Gets or sets the documentId. (optional)

List<System.String> recipients

Gets or sets the recipients. (optional)

System.Nullable<DateTime> startDate

Gets or sets the start date. (optional)

List<Status> status

Gets or sets the status. (optional)

System.Nullable<DateTime> endDate

Gets or sets the endDate. (optional)

System.String searchKey

Gets or sets the searchKey. (optional)

List<System.String> labels
System.Nullable<TransmitType> transmitType
Returns
Type Description
ApiResponse<DocumentRecords>

ApiResponse of DocumentRecords

Exceptions
Type Condition
ApiException

Thrown when fails to make API call

| Improve this Doc View Source

ListTeamDocuments(Int32, Nullable<Int32>, Nullable<DateTime>, List<Status>, List<String>, List<String>, Nullable<DateTime>, String, List<String>, Nullable<TransmitType>)

List all user team documents which can be filtered by date, time, teamid, userid, status, and so on.

Declaration
public TeamDocumentRecords ListTeamDocuments(int page, int? pageSize = null, DateTime? startDate = null, List<Status> status = null, List<string> teamId = null, List<string> userId = null, DateTime? endDate = null, string searchKey = null, List<string> labels = null, TransmitType? transmitType = null)
Parameters
Type Name Description
System.Int32 page

Gets or sets the page.

System.Nullable<System.Int32> pageSize

Gets or sets the page size. (optional, default to 10).

System.Nullable<DateTime> startDate

Gets or sets the start date. (optional).

List<Status> status

Gets or sets the status. (optional).

List<System.String> teamId

Gets or sets the teamId. (optional).

List<System.String> userId

Gets or sets the userId. (optional).

System.Nullable<DateTime> endDate

Gets or sets the endDate. (optional).

System.String searchKey

Gets or sets the searchKey. (optional).

List<System.String> labels

Gets or set the labels.

System.Nullable<TransmitType> transmitType

transmitType.

Returns
Type Description
TeamDocumentRecords

ApiResponse of TeamDocumentRecords.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call.

| Improve this Doc View Source

ListTeamDocumentsAsync(Int32, Nullable<Int32>, Nullable<DateTime>, List<Status>, List<String>, List<String>, Nullable<DateTime>, String, List<String>, Nullable<TransmitType>)

List all user team documents which can be filtered by date, time, teamid, userid, status, and so on.

Declaration
public async Task<TeamDocumentRecords> ListTeamDocumentsAsync(int page, int? pageSize = null, DateTime? startDate = null, List<Status> status = null, List<string> teamId = null, List<string> userId = null, DateTime? endDate = null, string searchKey = null, List<string> labels = null, TransmitType? transmitType = null)
Parameters
Type Name Description
System.Int32 page

Gets or sets the page.

System.Nullable<System.Int32> pageSize

Gets or sets the page size. (optional, default to 10).

System.Nullable<DateTime> startDate

Gets or sets the start date. (optional).

List<Status> status

Gets or sets the status. (optional).

List<System.String> teamId

Gets or sets the teamId. (optional).

List<System.String> userId

Gets or sets the userId. (optional).

System.Nullable<DateTime> endDate

Gets or sets the endDate. (optional).

System.String searchKey

Gets or sets the searchKey. (optional).

List<System.String> labels

Gets or set the labels.

System.Nullable<TransmitType> transmitType

transmitType.

Returns
Type Description
Task<TeamDocumentRecords>

Task of TeamDocumentRecords.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call.

| Improve this Doc View Source

ListTeamDocumentsAsyncWithHttpInfo(Int32, Nullable<Int32>, Nullable<DateTime>, List<Status>, List<String>, List<String>, Nullable<DateTime>, String, List<String>, Nullable<TransmitType>)

List all user team documents which can be filtered by date, time, teamid, userid, status, and so on.

Declaration
public async Task<ApiResponse<TeamDocumentRecords>> ListTeamDocumentsAsyncWithHttpInfo(int page, int? pageSize = null, DateTime? startDate = null, List<Status> status = null, List<string> teamId = null, List<string> userId = null, DateTime? endDate = null, string searchKey = null, List<string> labels = null, TransmitType? transmitType = null)
Parameters
Type Name Description
System.Int32 page

Gets or sets the page.

System.Nullable<System.Int32> pageSize

Gets or sets the page size. (optional, default to 10).

System.Nullable<DateTime> startDate

Gets or sets the start date. (optional).

List<Status> status

Gets or sets the status. (optional).

List<System.String> teamId

Gets or sets the teamId. (optional).

List<System.String> userId

Gets or sets the userId. (optional).

System.Nullable<DateTime> endDate

Gets or sets the endDate. (optional).

System.String searchKey

Gets or sets the searchKey. (optional).

List<System.String> labels

Gets or set the labels.

System.Nullable<TransmitType> transmitType

transmitType.

Returns
Type Description
Task<ApiResponse<TeamDocumentRecords>>

Task of ApiResponse (TeamDocumentRecords).

Exceptions
Type Condition
ApiException

Thrown when fails to make API call.

| Improve this Doc View Source

ListTeamDocumentsWithHttpInfo(Int32, Nullable<Int32>, Nullable<DateTime>, List<Status>, List<String>, List<String>, Nullable<DateTime>, String, List<String>, Nullable<TransmitType>)

List all user team documents which can be filtered by date, time, teamid, userid, status, and so on.

Declaration
public ApiResponse<TeamDocumentRecords> ListTeamDocumentsWithHttpInfo(int page, int? pageSize = null, DateTime? startDate = null, List<Status> status = null, List<string> teamId = null, List<string> userId = null, DateTime? endDate = null, string searchKey = null, List<string> labels = null, TransmitType? transmitType = null)
Parameters
Type Name Description
System.Int32 page

Gets or sets the page.

System.Nullable<System.Int32> pageSize

Gets or sets the page size. (optional, default to 10).

System.Nullable<DateTime> startDate

Gets or sets the start date. (optional).

List<Status> status

Gets or sets the status. (optional).

List<System.String> teamId

Gets or sets the teamId. (optional).

List<System.String> userId

Gets or sets the userId. (optional).

System.Nullable<DateTime> endDate

Gets or sets the endDate. (optional).

System.String searchKey

Gets or sets the searchKey. (optional).

List<System.String> labels

Gets or set the labels.

System.Nullable<TransmitType> transmitType

transmitType.

Returns
Type Description
ApiResponse<TeamDocumentRecords>

ApiResponse of TeamDocumentRecords.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call.

| Improve this Doc View Source

RemindDocument(String, List<String>, ReminderMessage)

Send a reminder message to pending signers for a particular document to their respective email IDs.

Declaration
public void RemindDocument(string documentId, List<string> receiverEmails = null, ReminderMessage reminderMessage = null)
Parameters
Type Name Description
System.String documentId

Document Id.

List<System.String> receiverEmails

Signer emails.

ReminderMessage reminderMessage

Reminder Message for signers. (optional)

Exceptions
Type Condition
ApiException

Thrown when fails to make API call

| Improve this Doc View Source

RemindDocumentAsync(String, List<String>, ReminderMessage)

Send a reminder message to pending signers for a particular document to their respective email IDs.

Declaration
public async Task RemindDocumentAsync(string documentId, List<string> receiverEmails = null, ReminderMessage reminderMessage = null)
Parameters
Type Name Description
System.String documentId

Document Id.

List<System.String> receiverEmails

Signer emails.

ReminderMessage reminderMessage

Reminder Message for signers. (optional)

Returns
Type Description
Task

Task of void

Exceptions
Type Condition
ApiException

Thrown when fails to make API call

| Improve this Doc View Source

RemindDocumentAsyncWithHttpInfo(String, List<String>, ReminderMessage)

Send a reminder message to pending signers for a particular document to their respective email IDs.

Declaration
public async Task<ApiResponse<object>> RemindDocumentAsyncWithHttpInfo(string documentId, List<string> receiverEmails = null, ReminderMessage reminderMessage = null)
Parameters
Type Name Description
System.String documentId

Document Id.

List<System.String> receiverEmails

Signer emails.

ReminderMessage reminderMessage

Reminder Message for signers. (optional)

Returns
Type Description
Task<ApiResponse<System.Object>>

Task of ApiResponse

Exceptions
Type Condition
ApiException

Thrown when fails to make API call

| Improve this Doc View Source

RemindDocumentWithHttpInfo(String, List<String>, ReminderMessage)

Send a reminder message to pending signers for a particular document to their respective email IDs.

Declaration
public ApiResponse<object> RemindDocumentWithHttpInfo(string documentId, List<string> receiverEmails = null, ReminderMessage reminderMessage = null)
Parameters
Type Name Description
System.String documentId

Document Id.

List<System.String> receiverEmails

Signer emails.

ReminderMessage reminderMessage

Reminder Message for signers. (optional)

Returns
Type Description
ApiResponse<System.Object>

ApiResponse of Object(void)

Exceptions
Type Condition
ApiException

Thrown when fails to make API call

| Improve this Doc View Source

RemoveAuthentication(String, String, Nullable<Int32>)

Removes the access code for the desired document signer by verifying the email ID of the signer.

Declaration
public void RemoveAuthentication(string documentId, string emailId, int? signerOrder = null)
Parameters
Type Name Description
System.String documentId

Gets or sets the document id.

System.String emailId

Gets or sets the signer email.

System.Nullable<System.Int32> signerOrder

Gets or sets the signer's order. When signer order is enabled for a document, this order is used to target that particular order with given signer email. (optional).

Exceptions
Type Condition
ApiException

Thrown when fails to make API call.

| Improve this Doc View Source

RemoveAuthenticationAsync(String, String, Nullable<Int32>)

Removes the access code for the desired document signer by verifying the email ID of the signer.

Declaration
public async Task RemoveAuthenticationAsync(string documentId, string emailId, int? signerOrder = null)
Parameters
Type Name Description
System.String documentId

Gets or sets the document id.

System.String emailId

Gets or sets the signer email.

System.Nullable<System.Int32> signerOrder

Gets or sets the signer's order. When signer order is enabled for a document, this order is used to target that particular order with given signer email. (optional).

Returns
Type Description
Task

Task of void.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call.

| Improve this Doc View Source

RemoveAuthenticationAsyncWithHttpInfo(String, String, Nullable<Int32>)

Changes the access code for the desired document signer by verifying the email ID of the signer.

Declaration
public async Task<ApiResponse<object>> RemoveAuthenticationAsyncWithHttpInfo(string documentId, string emailId, int? signerOrder = null)
Parameters
Type Name Description
System.String documentId

Gets or sets the document id.

System.String emailId

Gets or sets the signer email.

System.Nullable<System.Int32> signerOrder

Gets or sets the signer's order. When signer order is enabled for a document, this order is used to target that particular order with given signer email. (optional).

Returns
Type Description
Task<ApiResponse<System.Object>>

Task of ApiResponse.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call.

| Improve this Doc View Source

RemoveAuthenticationWithHttpInfo(String, String, Nullable<Int32>)

Removes the access code for the desired document signer by verifying the email ID of the signer.

Declaration
public ApiResponse<object> RemoveAuthenticationWithHttpInfo(string documentId, string emailId, int? signerOrder = null)
Parameters
Type Name Description
System.String documentId

Gets or sets the document id.

System.String emailId

Gets or sets the signer email.

System.Nullable<System.Int32> signerOrder

Gets or sets the signer's order. When signer order is enabled for a document, this order is used to target that particular order with given signer email. (optional).

Returns
Type Description
ApiResponse<System.Object>

ApiResponse of Object(void).

Exceptions
Type Condition
ApiException

Thrown when fails to make API call.

| Improve this Doc View Source

RevokeDocument(String, String)

Revoke the document with the given document ID.

Declaration
public void RevokeDocument(string documentId, string revokeMessage)
Parameters
Type Name Description
System.String documentId

Document Id.

System.String revokeMessage

RevokeDetails.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call

| Improve this Doc View Source

RevokeDocumentAsync(String, String)

Revoke the document with the given document ID.

Declaration
public async Task RevokeDocumentAsync(string documentId, string revokeMessage)
Parameters
Type Name Description
System.String documentId

Document Id.

System.String revokeMessage

RevokeDetails.

Returns
Type Description
Task

Task of void

Exceptions
Type Condition
ApiException

Thrown when fails to make API call

| Improve this Doc View Source

RevokeDocumentAsyncWithHttpInfo(String, String)

Revoke the document with the given document ID.

Declaration
public async Task<ApiResponse<object>> RevokeDocumentAsyncWithHttpInfo(string documentId, string revokeMessage)
Parameters
Type Name Description
System.String documentId

Document Id.

System.String revokeMessage

RevokeDetails.

Returns
Type Description
Task<ApiResponse<System.Object>>

Task of ApiResponse

Exceptions
Type Condition
ApiException

Thrown when fails to make API call

| Improve this Doc View Source

RevokeDocumentWithHttpInfo(String, String)

Revoke the document with the given document ID.

Declaration
public ApiResponse<object> RevokeDocumentWithHttpInfo(string documentId, string revokeMessage)
Parameters
Type Name Description
System.String documentId

Document Id.

System.String revokeMessage

RevokeDetails.

Returns
Type Description
ApiResponse<System.Object>

ApiResponse of Object(void)

Exceptions
Type Condition
ApiException

Thrown when fails to make API call

| Improve this Doc View Source

SendDocument(SendForSign)

Sends the document for sign.

Declaration
public DocumentCreated SendDocument(SendForSign signRequestDetails)
Parameters
Type Name Description
SendForSign signRequestDetails
Returns
Type Description
DocumentCreated

DocumentCreated

Exceptions
Type Condition
ApiException

Thrown when fails to make API call

| Improve this Doc View Source

SendDocumentAsync(SendForSign)

Sends the document for sign.

Declaration
public async Task<DocumentCreated> SendDocumentAsync(SendForSign signRequestDetails)
Parameters
Type Name Description
SendForSign signRequestDetails
Returns
Type Description
Task<DocumentCreated>

Task of DocumentCreated

Exceptions
Type Condition
ApiException

Thrown when fails to make API call

| Improve this Doc View Source

SendDocumentAsyncWithHttpInfo(SendForSign)

Sends the document for sign.

Declaration
public async Task<ApiResponse<DocumentCreated>> SendDocumentAsyncWithHttpInfo(SendForSign signRequestDetails)
Parameters
Type Name Description
SendForSign signRequestDetails
Returns
Type Description
Task<ApiResponse<DocumentCreated>>

Task of ApiResponse (DocumentCreated)

Exceptions
Type Condition
ApiException

Thrown when fails to make API call

| Improve this Doc View Source

SendDocumentWithHttpInfo(SendForSign)

Sends the document for sign.

Declaration
public ApiResponse<DocumentCreated> SendDocumentWithHttpInfo(SendForSign signRequestDetails)
Parameters
Type Name Description
SendForSign signRequestDetails
Returns
Type Description
ApiResponse<DocumentCreated>

ApiResponse of DocumentCreated

Exceptions
Type Condition
ApiException

Thrown when fails to make API call

Implements

IDocumentClient
IApiAccessor
  • Improve this Doc
  • View Source
In This Article
Back to top Copyright 2001-2021 Syncfusion Inc.
All Rights Reserved