Table of Contents

Class DocumentClient

Namespace
BoldSign.Api
Assembly
BoldSign.Api.dll

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.

public class DocumentClient : IDocumentClient, IApiAccessor
Inheritance
DocumentClient
Implements
Inherited Members

Constructors

DocumentClient()

Initializes a new instance of the DocumentClient class.

public DocumentClient()

DocumentClient(ApiClient)

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

public DocumentClient(ApiClient apiClient)

Parameters

apiClient ApiClient

An instance of ApiClient

DocumentClient(Configuration)

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

public DocumentClient(Configuration configuration = null)

Parameters

configuration Configuration

An instance of Configuration

DocumentClient(string)

Initializes a new instance of the DocumentClient class.

public DocumentClient(string basePath)

Parameters

basePath string

Properties

Configuration

Gets or sets the configuration object.

public Configuration Configuration { get; set; }

Property Value

Configuration

An instance of the Configuration

ExceptionFactory

Provides a factory method hook for the creation of exceptions.

public ExceptionFactory ExceptionFactory { get; set; }

Property Value

ExceptionFactory

Methods

AddAuthentication(string, string, AuthenticationType, int?, string, string, PhoneNumber, int?, IdentityVerificationSettings)

Add Authentication to user.

public void AddAuthentication(string documentId, string emailId = null, AuthenticationType authenticationType = AuthenticationType.None, int? signerOrder = null, string newAccessCode = "", string onBehalfOf = null, PhoneNumber phoneNumber = null, int? authenticationRetryCount = null, IdentityVerificationSettings identityVerificationSettings = null)

Parameters

documentId string

DocumentId.

emailId string

EmailID.

authenticationType AuthenticationType

AuthenticationType.

signerOrder int?

SignerOrder.

newAccessCode string

NewAccesscode.

onBehalfOf string

The on behalf of email.

phoneNumber PhoneNumber

The signer phone number.

authenticationRetryCount int?

The authentication retry count.

identityVerificationSettings IdentityVerificationSettings

The identity verification settings.

Exceptions

ApiException

Thrown when fails to make API call.

AddAuthenticationAsync(string, string, AuthenticationType, int?, string, string, PhoneNumber, int?, IdentityVerificationSettings)

Add Authentication to user.

public Task AddAuthenticationAsync(string documentId, string emailId = null, AuthenticationType authenticationType = AuthenticationType.None, int? signerOrder = null, string newAccessCode = "", string onBehalfOf = null, PhoneNumber phoneNumber = null, int? authenticationRetryCount = null, IdentityVerificationSettings identityVerificationSettings = null)

Parameters

documentId string

DocumentId.

emailId string

EmailID.

authenticationType AuthenticationType

AuthenticationType.

signerOrder int?

SignerOrder.

newAccessCode string

NewAccesscode.

onBehalfOf string

The on behalf of email.

phoneNumber PhoneNumber

The signer phone number.

authenticationRetryCount int?

The authentication retry count.

identityVerificationSettings IdentityVerificationSettings

The identity verification settings.

Returns

Task

AddAuthentication.

Exceptions

ApiException

Thrown when fails to make API call.

AddAuthenticationAsyncWithHttpInfo(string, string, AuthenticationType, int?, string, string, PhoneNumber, int?, IdentityVerificationSettings)

Add Authentication to user.

public Task<ApiResponse<object>> AddAuthenticationAsyncWithHttpInfo(string documentId, string emailId = null, AuthenticationType authenticationType = AuthenticationType.None, int? signerOrder = null, string newAccessCode = "", string onBehalfOf = null, PhoneNumber phoneNumber = null, int? authenticationRetryCount = null, IdentityVerificationSettings identityVerificationSettings = null)

Parameters

documentId string

DocumentId.

emailId string

EmailID.

authenticationType AuthenticationType

AuthenticationType.

signerOrder int?

SignerOrder.

newAccessCode string

NewAccesscode.

onBehalfOf string

The on behalf of email.

phoneNumber PhoneNumber

The signer phone number.

authenticationRetryCount int?

The authentication retry count.

identityVerificationSettings IdentityVerificationSettings

The identity verification settings.

Returns

Task<ApiResponse<object>>

ApiResponse of Object(AddAuthentication).

Exceptions

ApiException

Thrown when fails to make API call.

AddAuthenticationWithHttpInfo(string, string, AuthenticationType, int?, string, string, PhoneNumber, int?, IdentityVerificationSettings)

Add Authentication to user.

public ApiResponse<object> AddAuthenticationWithHttpInfo(string documentId, string emailId = null, AuthenticationType authenticationType = AuthenticationType.None, int? signerOrder = null, string newAccessCode = "", string onBehalfOf = null, PhoneNumber phoneNumber = null, int? authenticationRetryCount = null, IdentityVerificationSettings identityVerificationSettings = null)

Parameters

documentId string

DocumentId.

emailId string

EmailID.

authenticationType AuthenticationType

AuthenticationType.

signerOrder int?

SignerOrder.

newAccessCode string

NewAccesscode.

onBehalfOf string

The on behalf of email.

phoneNumber PhoneNumber

The signer phone number.

authenticationRetryCount int?

The authentication retry count.

identityVerificationSettings IdentityVerificationSettings

The identity verification settings.

Returns

ApiResponse<object>

ApiResponse of Object(void).

Exceptions

ApiException

Thrown when fails to make API call.

AddTag(DocumentTags)

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

public void AddTag(DocumentTags addTags)

Parameters

addTags DocumentTags

contains DocumentId and Label Parameter.

Exceptions

ApiException

Thrown when fails to make API call.

AddTagAsync(DocumentTags)

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

public Task AddTagAsync(DocumentTags addTags)

Parameters

addTags DocumentTags

contains DocumentId and Label Parameter.

Returns

Task

Task of void.

Exceptions

ApiException

Thrown when fails to make API call.

AddTagAsyncWithHttpInfo(DocumentTags)

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

public Task<ApiResponse<object>> AddTagAsyncWithHttpInfo(DocumentTags addTags)

Parameters

addTags DocumentTags

contains DocumentId and Label Parameter.

Returns

Task<ApiResponse<object>>

ApiResponse of Object(void).

Exceptions

ApiException

Thrown when fails to make API call.

AddTagWithHttpInfo(DocumentTags)

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

public ApiResponse<object> AddTagWithHttpInfo(DocumentTags addTags)

Parameters

addTags DocumentTags

contains DocumentId and Label Parameter.

Returns

ApiResponse<object>

ApiResponse of Object(void).

Exceptions

ApiException

Thrown when fails to make API call.

ChangeAccessCode(string, string, string, int?, string, PhoneNumber)

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

public void ChangeAccessCode(string documentId, string emailId = null, string newAccessCode = null, int? signerOrder = null, string onBehalfOf = null, PhoneNumber phoneNumber = null)

Parameters

documentId string

Gets or sets the document id.

emailId string

Gets or sets the signer email.

newAccessCode string

The new access code.

signerOrder int?

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)

onBehalfOf string

The on behalfof email.

phoneNumber PhoneNumber

The phone number.

Exceptions

ApiException

Thrown when fails to make API call

ChangeAccessCodeAsync(string, string, string, int?, string, PhoneNumber)

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

public Task ChangeAccessCodeAsync(string documentId, string emailId = null, string newAccessCode = null, int? signerOrder = null, string onBehalfOf = null, PhoneNumber phoneNumber = null)

Parameters

documentId string

Gets or sets the document id.

emailId string

Gets or sets the signer email.

newAccessCode string

The new access code.

signerOrder int?

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)

onBehalfOf string

The on behalfof email.

phoneNumber PhoneNumber

The phone number.

Returns

Task

Task of void

Exceptions

ApiException

Thrown when fails to make API call

ChangeAccessCodeAsyncWithHttpInfo(string, string, string, int?, string, PhoneNumber)

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

public Task<ApiResponse<object>> ChangeAccessCodeAsyncWithHttpInfo(string documentId, string emailId = null, string newAccessCode = null, int? signerOrder = null, string onBehalfOf = null, PhoneNumber phoneNumber = null)

Parameters

documentId string

Gets or sets the document id.

emailId string

Gets or sets the signer email.

newAccessCode string

The new access code.

signerOrder int?

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)

onBehalfOf string

The on behalfof email.

phoneNumber PhoneNumber

The phone number.

Returns

Task<ApiResponse<object>>

Task of ApiResponse

Exceptions

ApiException

Thrown when fails to make API call

ChangeAccessCodeWithHttpInfo(string, string, string, int?, string, PhoneNumber)

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

public ApiResponse<object> ChangeAccessCodeWithHttpInfo(string documentId, string emailId = null, string newAccessCode = null, int? signerOrder = null, string onBehalfOf = null, PhoneNumber phoneNumber = null)

Parameters

documentId string

Gets or sets the document id.

emailId string

Gets or sets the signer email.

newAccessCode string

The new access code.

signerOrder int?

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)

onBehalfOf string

The on behalfof email.

phoneNumber PhoneNumber

The phone number.

Returns

ApiResponse<object>

ApiResponse of Object(void)

Exceptions

ApiException

Thrown when fails to make API call

ChangeRecipient(string, string, string, string, string, int?, string, PhoneNumber, PhoneNumber)

Change recipient details of a document.

public void ChangeRecipient(string documentId, string oldSignerEmail = null, string reason = null, string newSignerName = null, string newSignerEmail = null, int? signerOrder = null, string onBehalfOf = null, PhoneNumber phoneNumber = null, PhoneNumber oldPhoneNumber = null)

Parameters

documentId string

The document id.

oldSignerEmail string

The signer email.

reason string

The reason for changing recipient details.

newSignerName string

The new name of the recipient.

newSignerEmail string

The new email address of recipient.

signerOrder int?

The signer order.

onBehalfOf string

The on behalfof email.

phoneNumber PhoneNumber

The signer phone number.

oldPhoneNumber PhoneNumber

The Old Signer Phone Number.

Exceptions

ApiException

Thrown when fails to make API call.

ChangeRecipientWithHttpInfo(string, string, string, string, string, int?, string, PhoneNumber, PhoneNumber)

Change recipient details of a document.

public ApiResponse<object> ChangeRecipientWithHttpInfo(string documentId, string oldSignerEmail = null, string reason = null, string newSignerName = null, string newSignerEmail = null, int? signerOrder = null, string onBehalfOf = null, PhoneNumber phoneNumber = null, PhoneNumber oldPhoneNumber = null)

Parameters

documentId string

The document id.

oldSignerEmail string

The signer email.

reason string

The reason for changing recipient details.

newSignerName string

The new name of the recipient.

newSignerEmail string

The new email address of recipient.

signerOrder int?

The signer order.

onBehalfOf string

The on behalfof email.

phoneNumber PhoneNumber

The signer phone number.

oldPhoneNumber PhoneNumber

The old Signer phone Number.

Returns

ApiResponse<object>

ApiResponse of Object(void).

Exceptions

ApiException

Thrown when fails to make API call.

ChangeRecipientasync(string, string, string, string, string, int?, string, PhoneNumber, PhoneNumber)

Change recipient details of a document.

public Task ChangeRecipientasync(string documentId, string oldSignerEmail = null, string reason = null, string newSignerName = null, string newSignerEmail = null, int? signerOrder = null, string onBehalfOf = null, PhoneNumber phoneNumber = null, PhoneNumber oldPhoneNumber = null)

Parameters

documentId string

The document id.

oldSignerEmail string

The signer email.

reason string

The reason for changing recipient details.

newSignerName string

The new name of the recipient .

newSignerEmail string

The new email address of recipient .

signerOrder int?

The signer order.

onBehalfOf string

The on behalfof email.

phoneNumber PhoneNumber

The signer phone number.

oldPhoneNumber PhoneNumber

The Old Signer Phone number.

Returns

Task

A Task representing the asynchronous operation.

Exceptions

ApiException

Thrown when fails to make API call.

ChangeRecipientasyncWithHttpInfo(string, string, string, string, string, int?, string, PhoneNumber, PhoneNumber)

Change recipient details of a document.

public Task<ApiResponse<object>> ChangeRecipientasyncWithHttpInfo(string documentId, string oldSignerEmail = null, string reason = null, string newSignerName = null, string newSignerEmail = null, int? signerOrder = null, string onBehalfOf = null, PhoneNumber phoneNumber = null, PhoneNumber oldPhoneNumber = null)

Parameters

documentId string

The document id.

oldSignerEmail string

The signer email.

reason string

The reason for changing recipient details.

newSignerName string

The new name of the recipient .

newSignerEmail string

The new email address of recipient .

signerOrder int?

The signer order.

onBehalfOf string

The on behalfof email.

phoneNumber PhoneNumber

The signer phone number.

oldPhoneNumber PhoneNumber

The Old signer phone number.

Returns

Task<ApiResponse<object>>

ApiResponse of Object(void).

Exceptions

ApiException

Thrown when fails to make API call.

CreateEmbeddedRequestUrl(EmbeddedDocumentRequest)

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

public EmbeddedSendCreated CreateEmbeddedRequestUrl(EmbeddedDocumentRequest sendRequest)

Parameters

sendRequest EmbeddedDocumentRequest

The signRequestDetails.

Returns

EmbeddedSendCreated

EmbeddedSendCreated.

Exceptions

ApiException

Thrown when fails to make API call.

CreateEmbeddedRequestUrlAsync(EmbeddedDocumentRequest)

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

public Task<EmbeddedSendCreated> CreateEmbeddedRequestUrlAsync(EmbeddedDocumentRequest sendRequest)

Parameters

sendRequest EmbeddedDocumentRequest

The signRequestDetails.

Returns

Task<EmbeddedSendCreated>

Task of EmbeddedSendCreated.

Exceptions

ApiException

Thrown when fails to make API call.

CreateEmbeddedRequestUrlAsyncWithHttpInfo(EmbeddedDocumentRequest)

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

public Task<ApiResponse<EmbeddedSendCreated>> CreateEmbeddedRequestUrlAsyncWithHttpInfo(EmbeddedDocumentRequest sendRequest)

Parameters

sendRequest EmbeddedDocumentRequest

The signRequestDetails.

Returns

Task<ApiResponse<EmbeddedSendCreated>>

Task of ApiResponse (EmbeddedSendCreated).

Exceptions

ApiException

Thrown when fails to make API call.

CreateEmbeddedRequestUrlWithHttpInfo(EmbeddedDocumentRequest)

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

public ApiResponse<EmbeddedSendCreated> CreateEmbeddedRequestUrlWithHttpInfo(EmbeddedDocumentRequest sendRequest)

Parameters

sendRequest EmbeddedDocumentRequest

The signRequestDetails.

Returns

ApiResponse<EmbeddedSendCreated>

ApiResponse of EmbeddedSendCreated.

Exceptions

ApiException

Thrown when fails to make API call.

DeleteDocument(string, bool)

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

public void DeleteDocument(string documentId, bool deletePermanently = false)

Parameters

documentId string

Document Id.

deletePermanently bool

if true, the document will be deleted permanently. if false, the document will be moved to the trash.

Exceptions

ApiException

Thrown when fails to make API call

DeleteDocumentAsync(string, bool)

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

public Task DeleteDocumentAsync(string documentId, bool deletePermanently = false)

Parameters

documentId string

Document Id.

deletePermanently bool

if true, the document will be deleted permanently. if false, the document will be moved to the trash.

Returns

Task

Task of void

Exceptions

ApiException

Thrown when fails to make API call

DeleteDocumentAsyncWithHttpInfo(string, bool)

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

public Task<ApiResponse<object>> DeleteDocumentAsyncWithHttpInfo(string documentId, bool deletePermanently = false)

Parameters

documentId string

Document Id.

deletePermanently bool

if true, the document will be deleted permanently. if false, the document will be moved to the trash.

Returns

Task<ApiResponse<object>>

Task of ApiResponse

Exceptions

ApiException

Thrown when fails to make API call

DeleteDocumentWithHttpInfo(string, bool)

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

public ApiResponse<object> DeleteDocumentWithHttpInfo(string documentId, bool deletePermanently = false)

Parameters

documentId string

Document Id.

deletePermanently bool

if true, the document will be deleted permanently. if false, the document will be moved to the trash.

Returns

ApiResponse<object>

ApiResponse of Object(void)

Exceptions

ApiException

Thrown when fails to make API call

DeleteTag(DocumentTags)

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

public void DeleteTag(DocumentTags deleteTags)

Parameters

deleteTags DocumentTags

contains DocumentId and Label Parameter.

Exceptions

ApiException

Thrown when fails to make API call.

DeleteTagAsync(DocumentTags)

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

public Task DeleteTagAsync(DocumentTags deleteTags)

Parameters

deleteTags DocumentTags

contains DocumentId and Label Parameter.

Returns

Task

ApiResponse of Object(void).

Exceptions

ApiException

Thrown when fails to make API call.

DeleteTagAsyncWithHttpInfo(DocumentTags)

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

public Task<ApiResponse<object>> DeleteTagAsyncWithHttpInfo(DocumentTags deleteTags)

Parameters

deleteTags DocumentTags

contains DocumentId and Label Parameter.

Returns

Task<ApiResponse<object>>

ApiResponse of Object(void).

Exceptions

ApiException

Thrown when fails to make API call.

DeleteTagWithHttpInfo(DocumentTags)

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

public ApiResponse<object> DeleteTagWithHttpInfo(DocumentTags deleteTags)

Parameters

deleteTags DocumentTags

contains DocumentId and Label Parameter.

Returns

ApiResponse<object>

ApiResponse of Object(void).

Exceptions

ApiException

Thrown when fails to make API call.

DownloadAttachment(string, string, string)

Download the attachment for given document ID and attachment ID.

public Stream DownloadAttachment(string documentId, string attachmentId, string onBehalfOf = null)

Parameters

documentId string

Document Id.

attachmentId string

attachmentId.

onBehalfOf string

OnBehalfOf Email.

Returns

Stream

System.IO.Stream.

Exceptions

ApiException

Thrown when fails to make API call.

DownloadAttachmentAsync(string, string, string)

Download the attachment for given document ID and attachment ID.

public Task<Stream> DownloadAttachmentAsync(string documentId, string attachmentId, string onBehalfOf = null)

Parameters

documentId string

Document Id.

attachmentId string

Attachment Id.

onBehalfOf string

OnBehalfOf Email.

Returns

Task<Stream>

Task of System.IO.Stream.

Exceptions

ApiException

Thrown when fails to make API call.

DownloadAttachmentAsyncWithHttpInfo(string, string, string)

Download the attachment for given document ID and attachment ID.

public Task<ApiResponse<Stream>> DownloadAttachmentAsyncWithHttpInfo(string documentId, string attachmentId, string onBehalfOf = null)

Parameters

documentId string

Document Id.

attachmentId string

Attachment Id.

onBehalfOf string

OnBehalfOf Email.

Returns

Task<ApiResponse<Stream>>

Task of ApiResponse (System.IO.Stream).

Exceptions

ApiException

Thrown when fails to make API call.

DownloadAttachmenttWithHttpInfo(string, string, string)

Download the attachment for given document ID and attachment ID.

public ApiResponse<Stream> DownloadAttachmenttWithHttpInfo(string documentId, string attachmentId, string onBehalfOf = null)

Parameters

documentId string

Document Id.

attachmentId string

attachmentId.

onBehalfOf string

OnBehalfOf Email.

Returns

ApiResponse<Stream>

ApiResponse of System.IO.Stream.

Exceptions

ApiException

Thrown when fails to make API call.

DownloadAuditLog(string, string)

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

public Stream DownloadAuditLog(string documentId, string onBehalfOf = null)

Parameters

documentId string

Document Id.

onBehalfOf string

The on behalfof email.

Returns

Stream

System.IO.Stream

Exceptions

ApiException

Thrown when fails to make API call

DownloadAuditLogAsync(string, string)

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

public Task<Stream> DownloadAuditLogAsync(string documentId, string onBehalfOf = null)

Parameters

documentId string

Document Id.

onBehalfOf string

The on behalfof email.

Returns

Task<Stream>

Task of System.IO.Stream

Exceptions

ApiException

Thrown when fails to make API call

DownloadAuditLogAsyncWithHttpInfo(string, string)

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

public Task<ApiResponse<Stream>> DownloadAuditLogAsyncWithHttpInfo(string documentId, string onBehalfOf = null)

Parameters

documentId string

Document Id.

onBehalfOf string

The on behalfof email.

Returns

Task<ApiResponse<Stream>>

Task of ApiResponse (System.IO.Stream)

Exceptions

ApiException

Thrown when fails to make API call

DownloadAuditLogWithHttpInfo(string, string)

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

public ApiResponse<Stream> DownloadAuditLogWithHttpInfo(string documentId, string onBehalfOf = null)

Parameters

documentId string

Document Id.

onBehalfOf string

The on behalfof email.

Returns

ApiResponse<Stream>

ApiResponse of System.IO.Stream

Exceptions

ApiException

Thrown when fails to make API call

DownloadDocument(string, string)

Download the document for given document ID.

public Stream DownloadDocument(string documentId, string onBehalfOf = null)

Parameters

documentId string

Document Id.

onBehalfOf string

The on behalfof email.

Returns

Stream

System.IO.Stream

Exceptions

ApiException

Thrown when fails to make API call

DownloadDocumentAsync(string, string)

Download the document for given document ID.

public Task<Stream> DownloadDocumentAsync(string documentId, string onBehalfOf = null)

Parameters

documentId string

Document Id.

onBehalfOf string

The on behalfof email.

Returns

Task<Stream>

Task of System.IO.Stream

Exceptions

ApiException

Thrown when fails to make API call

DownloadDocumentAsyncWithHttpInfo(string, string)

Download the document for given document ID.

public Task<ApiResponse<Stream>> DownloadDocumentAsyncWithHttpInfo(string documentId, string onBehalfOf = null)

Parameters

documentId string

Document Id.

onBehalfOf string

The on behalfof email.

Returns

Task<ApiResponse<Stream>>

Task of ApiResponse (System.IO.Stream)

Exceptions

ApiException

Thrown when fails to make API call

DownloadDocumentWithHttpInfo(string, string)

Download the document for given document ID.

public ApiResponse<Stream> DownloadDocumentWithHttpInfo(string documentId, string onBehalfOf = null)

Parameters

documentId string

Document Id.

onBehalfOf string

The on behalf of email.

Returns

ApiResponse<Stream>

ApiResponse of System.IO.Stream

Exceptions

ApiException

Thrown when fails to make API call

ExtendExpiry(string, string, bool?, string)

Extends the expiration date of the document.

public void ExtendExpiry(string documentId, string newExpiryValue, bool? warnPrior = null, string onBehalfOf = null)

Parameters

documentId string

The Document ID.

newExpiryValue string

The new expiry value should be specified in yyyy-MM-dd format for days type, ISO date time format for specific date time and integer for hours type.

warnPrior bool?

If null, the existing configuration will be used. If true, one day before the expiration date, a warning email will be sent. If false, a warning email will not be sent one day before the expiration date.

onBehalfOf string

The on behalfof email.

Exceptions

ApiException

Thrown when fails to make API call.

ExtendExpiryAsync(string, string, bool?, string)

Extends the expiration date of the document.

public Task ExtendExpiryAsync(string documentId, string newExpiryValue, bool? warnPrior = null, string onBehalfOf = null)

Parameters

documentId string

The Document ID.

newExpiryValue string

The new expiry value should be specified in yyyy-MM-dd format for days type, ISO date time format for specific date time and integer for hours type.

warnPrior bool?

If null, the existing configuration will be used. If true, one day before the expiration date, a warning email will be sent. If false, a warning email will not be sent one day before the expiration date.

onBehalfOf string

The on behalfof email.

Returns

Task

Task representing the asynchronous operation.

Exceptions

ApiException

Thrown when fails to make API call.

ExtendExpiryAsyncWithHttpInfo(string, string, bool?, string)

Extends the expiration date of the document.

public Task<ApiResponse<object>> ExtendExpiryAsyncWithHttpInfo(string documentId, string newExpiryValue, bool? warnPrior = null, string onBehalfOf = null)

Parameters

documentId string

The Document ID.

newExpiryValue string

The new expiry value should be specified in yyyy-MM-dd format for days type, ISO date time format for specific date time and integer for hours type.

warnPrior bool?

If null, the existing configuration will be used. If true, one day before the expiration date, a warning email will be sent. If false, a warning email will not be sent one day before the expiration date.

onBehalfOf string

The on behalfof email.

Returns

Task<ApiResponse<object>>

Task of ApiResponse.

Exceptions

ApiException

Thrown when fails to make API call.

ExtendExpiryWithHttpinfo(string, string, bool?, string)

Extends the expiration date of the document.

public ApiResponse<object> ExtendExpiryWithHttpinfo(string documentId, string newExpiryValue, bool? warnPrior = null, string onBehalfOf = null)

Parameters

documentId string

The Document ID.

newExpiryValue string

The new expiry value should be specified in yyyy-MM-dd format for days type, ISO date time format for specific date time and integer for hours type.

warnPrior bool?

If null, the existing configuration will be used. If true, one day before the expiration date, a warning email will be sent. If false, a warning email will not be sent one day before the expiration date.

onBehalfOf string

The on behalfof email.

Returns

ApiResponse<object>

ApiResponse of Object(void).

Exceptions

ApiException

Thrown when fails to make API call.

GetBasePath()

Gets the base path of the API client.

public string GetBasePath()

Returns

string

The base path

GetEmbeddedSignLink(string, string, DateTime?, string, string, 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.

public EmbeddedSigningLink GetEmbeddedSignLink(string documentId, string signerEmail = null, DateTime? signLinkValidTill = null, string redirectUrl = null, string countryCode = null, string phoneNumber = null)

Parameters

documentId string

Gets or sets Document Id.

signerEmail string

Gets or sets signer email. (optional)

signLinkValidTill DateTime?

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

redirectUrl string

Gets or sets Redirect URL. (optional)

countryCode string

Gets or sets Country Code. (optional)

phoneNumber string

Gets or sets Phone Number. (optional)

Returns

EmbeddedSigningLink

EmbeddedSigningLink

Exceptions

ApiException

Thrown when fails to make API call

GetEmbeddedSignLinkAsync(string, string, DateTime?, string, string, 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.

public Task<EmbeddedSigningLink> GetEmbeddedSignLinkAsync(string documentId, string signerEmail = null, DateTime? signLinkValidTill = null, string redirectUrl = null, string countryCode = null, string phoneNumber = null)

Parameters

documentId string

Gets or sets Document Id.

signerEmail string

Gets or sets signer email. (optional)

signLinkValidTill DateTime?

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

redirectUrl string

Gets or sets Redirect URL. (optional)

countryCode string

Gets or sets Country Code. (optional)

phoneNumber string

Gets or sets Phone Number. (optional)

Returns

Task<EmbeddedSigningLink>

Task of EmbeddedSigningLink

Exceptions

ApiException

Thrown when fails to make API call

GetEmbeddedSignLinkAsyncWithHttpInfo(string, string, DateTime?, string, string, 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.

public Task<ApiResponse<EmbeddedSigningLink>> GetEmbeddedSignLinkAsyncWithHttpInfo(string documentId, string signerEmail = null, DateTime? signLinkValidTill = null, string redirectUrl = null, string countryCode = null, string phoneNumber = null)

Parameters

documentId string

Gets or sets Document Id.

signerEmail string

Gets or sets signer email. (optional)

signLinkValidTill DateTime?

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

redirectUrl string

Gets or sets Redirect URL. (optional)

countryCode string

Gets or sets Country Code. (optional)

phoneNumber string

Gets or sets Phone Number. (optional)

Returns

Task<ApiResponse<EmbeddedSigningLink>>

Task of ApiResponse (EmbeddedSigningLink)

Exceptions

ApiException

Thrown when fails to make API call

GetEmbeddedSignLinkWithHttpInfo(string, string, DateTime?, string, string, 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.

public ApiResponse<EmbeddedSigningLink> GetEmbeddedSignLinkWithHttpInfo(string documentId, string signerEmail = null, DateTime? signLinkValidTill = null, string redirectUrl = null, string countryCode = null, string phoneNumber = null)

Parameters

documentId string

Gets or sets Document Id.

signerEmail string

Gets or sets signer email. (optional)

signLinkValidTill DateTime?

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

redirectUrl string

Gets or sets Redirect URL. (optional)

countryCode string

Gets or sets Country Code. (optional)

phoneNumber string

Gets or sets Phone Number. (optional)

Returns

ApiResponse<EmbeddedSigningLink>

ApiResponse of EmbeddedSigningLink

Exceptions

ApiException

Thrown when fails to make API call

GetProperties(string)

Get summary of the document for the given document ID.

public DocumentProperties GetProperties(string documentId)

Parameters

documentId string

Document Id.

Returns

DocumentProperties

DocumentProperties

Exceptions

ApiException

Thrown when fails to make API call

GetPropertiesAsync(string)

Get summary of the document for the given document ID.

public Task<DocumentProperties> GetPropertiesAsync(string documentId)

Parameters

documentId string

Document Id.

Returns

Task<DocumentProperties>

Task of DocumentProperties

Exceptions

ApiException

Thrown when fails to make API call

GetPropertiesAsyncWithHttpInfo(string)

Get summary of the document for the given document ID.

public Task<ApiResponse<DocumentProperties>> GetPropertiesAsyncWithHttpInfo(string documentId)

Parameters

documentId string

Document Id.

Returns

Task<ApiResponse<DocumentProperties>>

Task of ApiResponse (DocumentProperties)

Exceptions

ApiException

Thrown when fails to make API call

GetPropertiesWithHttpInfo(string)

Get summary of the document for the given document ID.

public ApiResponse<DocumentProperties> GetPropertiesWithHttpInfo(string documentId)

Parameters

documentId string

Document Id.

Returns

ApiResponse<DocumentProperties>

ApiResponse of DocumentProperties

Exceptions

ApiException

Thrown when fails to make API call

ListBehalfDocuments(int, int?, List<string>, List<Status>, string, PageType?, DateTime?, DateTime?, List<string>, List<string>, long?, List<string>)

List of behalf documents which can be filtered by status, page size and so on.

public BehalfDocumentRecords ListBehalfDocuments(int page = 1, int? pageSize = null, List<string> emailAddress = null, List<Status> status = null, string searchKey = null, PageType? pageType = null, DateTime? startDate = null, DateTime? endDate = null, List<string> signers = null, List<string> labels = null, long? nextCursor = null, List<string> brandIds = null)

Parameters

page int

Gets or sets the page index specified in get document list request.

pageSize int?

Gets or sets the page size specified in get document list request. (optional, default to 10).

emailAddress List<string>

Gets or sets the sender identity's email used to filter the documents returned in the API. The API will return documents that were sent on behalf of the specified email address. (optional).

status List<Status>

Gets or sets the status used to filter documents based on their current status, including In-progress, Completed, Declined, Expired, and Revoked. (optional).

searchKey string

Gets or sets the search key used to filter the documents returned in the API. The API will return documents that contain the search key in the document title, document ID, sender or signer(s) name, etc. (optional).

pageType PageType?

Gets or sets the page type used to differentiate between documents sent on the user's behalf and documents sent by the user on behalf of others. The API will return documents based on the specified value. (optional).

startDate DateTime?

Gets or sets the start date used to filter the documents returned in the API. The API will return documents that were created on or after this date (optional).

endDate DateTime?

Gets or sets the endDate used to filter the documents returned in the API. The API will return documents that were created on or before this date. (optional).

signers List<string>

Gets or sets the list of signer email addresses used to filter the documents returned in the API. The API will return documents where the signer's email address matches one of the email addresses provided in this list. (optional).

labels List<string>

Gets or sets the list of labels or tags used to filter the documents returned in the API. The API will return documents that have been tagged with one or more of the labels provided in this list. (optional).

nextCursor long?

Gets or sets the nextCursor.

brandIds List<string>

The list of brand IDs to filter associated with the behalf documents.

Returns

BehalfDocumentRecords

BehalfDocumentRecords.

Exceptions

ApiException

Thrown when fails to make API call.

ListBehalfDocumentsAsync(int, int?, List<string>, List<Status>, string, PageType?, DateTime?, DateTime?, List<string>, List<string>, long?, List<string>)

List of behalf documents which can be filtered by status, page size and so on.

public Task<BehalfDocumentRecords> ListBehalfDocumentsAsync(int page = 1, int? pageSize = null, List<string> emailAddress = null, List<Status> status = null, string searchKey = null, PageType? pageType = null, DateTime? startDate = null, DateTime? endDate = null, List<string> signers = null, List<string> labels = null, long? nextCursor = null, List<string> brandIds = null)

Parameters

page int

Gets or sets the page index specified in get document list request.

pageSize int?

Gets or sets the page size specified in get document list request. (optional, default to 10).

emailAddress List<string>

Gets or sets the sender identity's email used to filter the documents returned in the API. The API will return documents that were sent on behalf of the specified email address. (optional).

status List<Status>

Gets or sets the status used to filter documents based on their current status, including In-progress, Completed, Declined, Expired, and Revoked. (optional).

searchKey string

Gets or sets the search key used to filter the documents returned in the API. The API will return documents that contain the search key in the document title, document ID, sender or signer(s) name, etc. (optional).

pageType PageType?

Gets or sets the page type used to differentiate between documents sent on the user's behalf and documents sent by the user on behalf of others. The API will return documents based on the specified value. (optional).

startDate DateTime?

Gets or sets the start date used to filter the documents returned in the API. The API will return documents that were created on or after this date (optional).

endDate DateTime?

Gets or sets the endDate used to filter the documents returned in the API. The API will return documents that were created on or before this date. (optional).

signers List<string>

Gets or sets the list of signer email addresses used to filter the documents returned in the API. The API will return documents where the signer's email address matches one of the email addresses provided in this list. (optional).

labels List<string>

Gets or sets the list of labels or tags used to filter the documents returned in the API. The API will return documents that have been tagged with one or more of the labels provided in this list. (optional).

nextCursor long?

Gets or sets the nextCursor.

brandIds List<string>

The list of brand IDs to filter associated with the behalf documents.

Returns

Task<BehalfDocumentRecords>

Task of BehalfDocumentRecords.

Exceptions

ApiException

Thrown when fails to make API call.

ListBehalfDocumentsAsyncWithHttpInfo(int, int?, List<string>, List<Status>, string, PageType?, DateTime?, DateTime?, List<string>, List<string>, long?, List<string>)

List of behalf documents which can be filtered by status, page size and so on.

public Task<ApiResponse<BehalfDocumentRecords>> ListBehalfDocumentsAsyncWithHttpInfo(int page = 1, int? pageSize = null, List<string> emailAddress = null, List<Status> status = null, string searchKey = null, PageType? pageType = null, DateTime? startDate = null, DateTime? endDate = null, List<string> signers = null, List<string> labels = null, long? nextCursor = null, List<string> brandIds = null)

Parameters

page int

Gets or sets the page index specified in get document list request.

pageSize int?

Gets or sets the page size specified in get document list request. (optional, default to 10).

emailAddress List<string>

Gets or sets the sender identity's email used to filter the documents returned in the API. The API will return documents that were sent on behalf of the specified email address. (optional).

status List<Status>

Gets or sets the status used to filter documents based on their current status, including In-progress, Completed, Declined, Expired, and Revoked. (optional).

searchKey string

Gets or sets the search key used to filter the documents returned in the API. The API will return documents that contain the search key in the document title, document ID, sender or signer(s) name, etc. (optional).

pageType PageType?

Gets or sets the page type used to differentiate between documents sent on the user's behalf and documents sent by the user on behalf of others. The API will return documents based on the specified value. (optional).

startDate DateTime?

Gets or sets the start date used to filter the documents returned in the API. The API will return documents that were created on or after this date (optional).

endDate DateTime?

Gets or sets the endDate used to filter the documents returned in the API. The API will return documents that were created on or before this date. (optional).

signers List<string>

Gets or sets the list of signer email addresses used to filter the documents returned in the API. The API will return documents where the signer's email address matches one of the email addresses provided in this list. (optional).

labels List<string>

Gets or sets the list of labels or tags used to filter the documents returned in the API. The API will return documents that have been tagged with one or more of the labels provided in this list. (optional).

nextCursor long?

Gets or sets the nextCursor.

brandIds List<string>

The list of brand IDs to filter associated with the behalf documents.

Returns

Task<ApiResponse<BehalfDocumentRecords>>

Task of ApiResponse (BehalfDocumentRecords).

Exceptions

ApiException

Thrown when fails to make API call.

ListBehalfDocumentsWithHttpInfo(int, int?, List<string>, List<Status>, string, PageType?, DateTime?, DateTime?, List<string>, List<string>, long?, List<string>)

List of behalf documents which can be filtered by status, page size and so on.

public ApiResponse<BehalfDocumentRecords> ListBehalfDocumentsWithHttpInfo(int page = 1, int? pageSize = null, List<string> emailAddress = null, List<Status> status = null, string searchKey = null, PageType? pageType = null, DateTime? startDate = null, DateTime? endDate = null, List<string> signers = null, List<string> labels = null, long? nextCursor = null, List<string> brandIds = null)

Parameters

page int

Gets or sets the page index specified in get document list request.

pageSize int?

Gets or sets the page size specified in get document list request. (optional, default to 10).

emailAddress List<string>

Gets or sets the sender identity's email used to filter the documents returned in the API. The API will return documents that were sent on behalf of the specified email address. (optional).

status List<Status>

Gets or sets the status used to filter documents based on their current status, including In-progress, Completed, Declined, Expired, and Revoked. (optional).

searchKey string

Gets or sets the search key used to filter the documents returned in the API. The API will return documents that contain the search key in the document title, document ID, sender or signer(s) name, etc. (optional).

pageType PageType?

Gets or sets the page type used to differentiate between documents sent on the user's behalf and documents sent by the user on behalf of others. The API will return documents based on the specified value. (optional).

startDate DateTime?

Gets or sets the start date used to filter the documents returned in the API. The API will return documents that were created on or after this date (optional).

endDate DateTime?

Gets or sets the endDate used to filter the documents returned in the API. The API will return documents that were created on or before this date. (optional).

signers List<string>

Gets or sets the list of signer email addresses used to filter the documents returned in the API. The API will return documents where the signer's email address matches one of the email addresses provided in this list. (optional).

labels List<string>

Gets or sets the list of labels or tags used to filter the documents returned in the API. The API will return documents that have been tagged with one or more of the labels provided in this list. (optional).

nextCursor long?

Gets or sets the nextCursor.

brandIds List<string>

The list of brand IDs to filter associated with the behalf documents.

Returns

ApiResponse<BehalfDocumentRecords>

ApiResponse of BehalfDocumentRecords.

Exceptions

ApiException

Thrown when fails to make API call.

ListDocuments(int, int?, List<string>, List<string>, DateTime?, List<Status>, DateTime?, string, List<string>, TransmitType?, long?, List<string>, DateFilterType?)

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

public DocumentRecords ListDocuments(int page = 1, 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, long? nextCursor = null, List<string> brandIds = null, DateFilterType? dateFilterType = null)

Parameters

page int

Gets or sets the page.

pageSize int?

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

sentBy List<string>

Gets or sets the documentId. (optional)

recipients List<string>

Gets or sets the recipients. (optional)

startDate DateTime?

Gets or sets the start date. (optional)

status List<Status>

Gets or sets the status. (optional)

endDate DateTime?

Gets or sets the endDate. (optional)

searchKey string

Gets or sets the searchKey. (optional)

labels List<string>
transmitType TransmitType?
nextCursor long?

Gets or sets the nextCursor.

brandIds List<string>

Gets or sets the brandIds.

dateFilterType DateFilterType?

dateFilterType.

Returns

DocumentRecords

DocumentRecords

Exceptions

ApiException

Thrown when fails to make API call

ListDocumentsAsync(int, int?, List<string>, List<string>, DateTime?, List<Status>, DateTime?, string, List<string>, TransmitType?, long?, List<string>, DateFilterType?)

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

public Task<DocumentRecords> ListDocumentsAsync(int page = 1, 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, long? nextCursor = null, List<string> brandIds = null, DateFilterType? dateFilterType = null)

Parameters

page int

Gets or sets the page.

pageSize int?

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

sentBy List<string>

Gets or sets the documentId. (optional)

recipients List<string>

Gets or sets the recipients. (optional)

startDate DateTime?

Gets or sets the start date. (optional)

status List<Status>

Gets or sets the status. (optional)

endDate DateTime?

Gets or sets the endDate. (optional)

searchKey string

Gets or sets the searchKey. (optional)

labels List<string>
transmitType TransmitType?
nextCursor long?

Gets or sets the nextCursor.

brandIds List<string>

Gets or sets the brandIds.

dateFilterType DateFilterType?

dateFilterType.

Returns

Task<DocumentRecords>

Task of DocumentRecords

Exceptions

ApiException

Thrown when fails to make API call

ListDocumentsAsyncWithHttpInfo(int, int?, List<string>, List<string>, DateTime?, List<Status>, DateTime?, string, List<string>, TransmitType?, long?, List<string>, DateFilterType?)

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

public Task<ApiResponse<DocumentRecords>> ListDocumentsAsyncWithHttpInfo(int page = 1, 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, long? nextCursor = null, List<string> brandIds = null, DateFilterType? dateFilterType = null)

Parameters

page int

Gets or sets the page.

pageSize int?

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

sentBy List<string>

Gets or sets the documentId. (optional)

recipients List<string>

Gets or sets the recipients. (optional)

startDate DateTime?

Gets or sets the start date. (optional)

status List<Status>

Gets or sets the status. (optional)

endDate DateTime?

Gets or sets the endDate. (optional)

searchKey string

Gets or sets the searchKey. (optional)

labels List<string>
transmitType TransmitType?
nextCursor long?

Gets or sets the nextCursor.

brandIds List<string>

Gets or sets the brandIds.

dateFilterType DateFilterType?

dateFilterType.

Returns

Task<ApiResponse<DocumentRecords>>

Task of ApiResponse (DocumentRecords)

Exceptions

ApiException

Thrown when fails to make API call

ListDocumentsWithHttpInfo(int, int?, List<string>, List<string>, DateTime?, List<Status>, DateTime?, string, List<string>, TransmitType?, long?, List<string>, DateFilterType?)

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

public ApiResponse<DocumentRecords> ListDocumentsWithHttpInfo(int page = 1, 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, long? nextCursor = null, List<string> brandIds = null, DateFilterType? dateFilterType = null)

Parameters

page int

Gets or sets the page.

pageSize int?

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

sentBy List<string>

Gets or sets the documentId. (optional)

recipients List<string>

Gets or sets the recipients. (optional)

startDate DateTime?

Gets or sets the start date. (optional)

status List<Status>

Gets or sets the status. (optional)

endDate DateTime?

Gets or sets the endDate. (optional)

searchKey string

Gets or sets the searchKey. (optional)

labels List<string>
transmitType TransmitType?
nextCursor long?

Gets or sets the nextCursor.

brandIds List<string>

Gets or sets the brandIds.

dateFilterType DateFilterType?

dateFilterType.

Returns

ApiResponse<DocumentRecords>

ApiResponse of DocumentRecords

Exceptions

ApiException

Thrown when fails to make API call

ListTeamDocuments(int, int?, DateTime?, List<Status>, List<string>, List<string>, DateTime?, string, List<string>, TransmitType?, long?, List<string>, DateFilterType?)

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

public TeamDocumentRecords ListTeamDocuments(int page = 1, 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, long? nextCursor = null, List<string> brandIds = null, DateFilterType? dateFilterType = null)

Parameters

page int

Gets or sets the page.

pageSize int?

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

startDate DateTime?

Gets or sets the start date. (optional).

status List<Status>

Gets or sets the status. (optional).

teamId List<string>

Gets or sets the teamId. (optional).

userId List<string>

Gets or sets the userId. (optional).

endDate DateTime?

Gets or sets the endDate. (optional).

searchKey string

Gets or sets the searchKey. (optional).

labels List<string>

Gets or set the labels.

transmitType TransmitType?

transmitType.

nextCursor long?

Gets or sets the nextCursor.

brandIds List<string>

Gets or sets the brandIds.

dateFilterType DateFilterType?

dateFilterType.

Returns

TeamDocumentRecords

ApiResponse of TeamDocumentRecords.

Exceptions

ApiException

Thrown when fails to make API call.

ListTeamDocumentsAsync(int, int?, DateTime?, List<Status>, List<string>, List<string>, DateTime?, string, List<string>, TransmitType?, long?, List<string>, DateFilterType?)

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

public Task<TeamDocumentRecords> ListTeamDocumentsAsync(int page = 1, 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, long? nextCursor = null, List<string> brandIds = null, DateFilterType? dateFilterType = null)

Parameters

page int

Gets or sets the page.

pageSize int?

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

startDate DateTime?

Gets or sets the start date. (optional).

status List<Status>

Gets or sets the status. (optional).

teamId List<string>

Gets or sets the teamId. (optional).

userId List<string>

Gets or sets the userId. (optional).

endDate DateTime?

Gets or sets the endDate. (optional).

searchKey string

Gets or sets the searchKey. (optional).

labels List<string>

Gets or set the labels.

transmitType TransmitType?

transmitType.

nextCursor long?

Gets or sets the nextCursor.

brandIds List<string>

Gets or sets the brandIds.

dateFilterType DateFilterType?

dateFilterType.

Returns

Task<TeamDocumentRecords>

Task of TeamDocumentRecords.

Exceptions

ApiException

Thrown when fails to make API call.

ListTeamDocumentsAsyncWithHttpInfo(int, int?, DateTime?, List<Status>, List<string>, List<string>, DateTime?, string, List<string>, TransmitType?, long?, List<string>, DateFilterType?)

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

public Task<ApiResponse<TeamDocumentRecords>> ListTeamDocumentsAsyncWithHttpInfo(int page = 1, 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, long? nextCursor = null, List<string> brandIds = null, DateFilterType? dateFilterType = null)

Parameters

page int

Gets or sets the page.

pageSize int?

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

startDate DateTime?

Gets or sets the start date. (optional).

status List<Status>

Gets or sets the status. (optional).

teamId List<string>

Gets or sets the teamId. (optional).

userId List<string>

Gets or sets the userId. (optional).

endDate DateTime?

Gets or sets the endDate. (optional).

searchKey string

Gets or sets the searchKey. (optional).

labels List<string>

Gets or set the labels.

transmitType TransmitType?

transmitType.

nextCursor long?

Gets or sets the nextCursor.

brandIds List<string>

Gets or sets the brandIds.

dateFilterType DateFilterType?

dateFilterType.

Returns

Task<ApiResponse<TeamDocumentRecords>>

Task of ApiResponse (TeamDocumentRecords).

Exceptions

ApiException

Thrown when fails to make API call.

ListTeamDocumentsWithHttpInfo(int, int?, DateTime?, List<Status>, List<string>, List<string>, DateTime?, string, List<string>, TransmitType?, long?, List<string>, DateFilterType?)

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

public ApiResponse<TeamDocumentRecords> ListTeamDocumentsWithHttpInfo(int page = 1, 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, long? nextCursor = null, List<string> brandIds = null, DateFilterType? dateFilterType = null)

Parameters

page int

Gets or sets the page.

pageSize int?

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

startDate DateTime?

Gets or sets the start date. (optional).

status List<Status>

Gets or sets the status. (optional).

teamId List<string>

Gets or sets the teamId. (optional).

userId List<string>

Gets or sets the userId. (optional).

endDate DateTime?

Gets or sets the endDate. (optional).

searchKey string

Gets or sets the searchKey. (optional).

labels List<string>

Gets or set the labels.

transmitType TransmitType?

transmitType.

nextCursor long?

Gets or sets the nextCursor.

brandIds List<string>

Gets or sets the brandIds.

dateFilterType DateFilterType?

dateFilterType.

Returns

ApiResponse<TeamDocumentRecords>

ApiResponse of TeamDocumentRecords.

Exceptions

ApiException

Thrown when fails to make API call.

PrefillFields(PrefillFieldRequest)

Pre fill form fields.

public void PrefillFields(PrefillFieldRequest request)

Parameters

request PrefillFieldRequest

Exceptions

ApiException

Thrown when fails to make API call

PrefillFieldsAsync(PrefillFieldRequest)

Pre fill form fields.

public Task PrefillFieldsAsync(PrefillFieldRequest request)

Parameters

request PrefillFieldRequest

Returns

Task

Exceptions

ApiException

Thrown when fails to make API call

PrefillFieldsAsyncWithHttpInfo(PrefillFieldRequest)

Pre fill form fields.

public Task<ApiResponse<object>> PrefillFieldsAsyncWithHttpInfo(PrefillFieldRequest request)

Parameters

request PrefillFieldRequest

Returns

Task<ApiResponse<object>>

Exceptions

ApiException

Thrown when fails to make API call

PrefillFieldsWithHttpInfo(PrefillFieldRequest)

Pre fill form fields.

public ApiResponse<object> PrefillFieldsWithHttpInfo(PrefillFieldRequest request)

Parameters

request PrefillFieldRequest

Returns

ApiResponse<object>

Exceptions

ApiException

Thrown when fails to make API call

RemindDocument(string, List<string>, ReminderMessage)

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

public void RemindDocument(string documentId, List<string> receiverEmails = null, ReminderMessage reminderMessage = null)

Parameters

documentId string

Document Id.

receiverEmails List<string>

Signer emails.

reminderMessage ReminderMessage

Reminder Message for signers. (optional)

Exceptions

ApiException

Thrown when fails to make API call

RemindDocumentAsync(string, List<string>, ReminderMessage)

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

public Task RemindDocumentAsync(string documentId, List<string> receiverEmails = null, ReminderMessage reminderMessage = null)

Parameters

documentId string

Document Id.

receiverEmails List<string>

Signer emails.

reminderMessage ReminderMessage

Reminder Message for signers. (optional)

Returns

Task

Task of void

Exceptions

ApiException

Thrown when fails to make API call

RemindDocumentAsyncWithHttpInfo(string, List<string>, ReminderMessage)

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

public Task<ApiResponse<object>> RemindDocumentAsyncWithHttpInfo(string documentId, List<string> receiverEmails = null, ReminderMessage reminderMessage = null)

Parameters

documentId string

Document Id.

receiverEmails List<string>

Signer emails.

reminderMessage ReminderMessage

Reminder Message for signers. (optional)

Returns

Task<ApiResponse<object>>

Task of ApiResponse

Exceptions

ApiException

Thrown when fails to make API call

RemindDocumentWithHttpInfo(string, List<string>, ReminderMessage)

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

public ApiResponse<object> RemindDocumentWithHttpInfo(string documentId, List<string> receiverEmails = null, ReminderMessage reminderMessage = null)

Parameters

documentId string

Document Id.

receiverEmails List<string>

Signer emails.

reminderMessage ReminderMessage

Reminder Message for signers. (optional)

Returns

ApiResponse<object>

ApiResponse of Object(void)

Exceptions

ApiException

Thrown when fails to make API call

RemoveAuthentication(string, string, int?, string, PhoneNumber)

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

public void RemoveAuthentication(string documentId, string emailId = null, int? signerOrder = null, string onBehalfOf = null, PhoneNumber phoneNumber = null)

Parameters

documentId string

Gets or sets the document id.

emailId string

Gets or sets the signer email.

signerOrder int?

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

onBehalfOf string

The on behalfof email.

phoneNumber PhoneNumber

The phone number.

Exceptions

ApiException

Thrown when fails to make API call.

RemoveAuthenticationAsync(string, string, int?, string, PhoneNumber)

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

public Task RemoveAuthenticationAsync(string documentId, string emailId = null, int? signerOrder = null, string onBehalfOf = null, PhoneNumber phoneNumber = null)

Parameters

documentId string

Gets or sets the document id.

emailId string

Gets or sets the signer email.

signerOrder int?

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

onBehalfOf string

The on behalfof email.

phoneNumber PhoneNumber

The phone number.

Returns

Task

Task of void.

Exceptions

ApiException

Thrown when fails to make API call.

RemoveAuthenticationAsyncWithHttpInfo(string, string, int?, string, PhoneNumber)

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

public Task<ApiResponse<object>> RemoveAuthenticationAsyncWithHttpInfo(string documentId, string emailId = null, int? signerOrder = null, string onBehalfOf = null, PhoneNumber phoneNumber = null)

Parameters

documentId string

Gets or sets the document id.

emailId string

Gets or sets the signer email.

signerOrder int?

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

onBehalfOf string

The on behalfof email.

phoneNumber PhoneNumber

The phone number.

Returns

Task<ApiResponse<object>>

Task of ApiResponse.

Exceptions

ApiException

Thrown when fails to make API call.

RemoveAuthenticationWithHttpInfo(string, string, int?, string, PhoneNumber)

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

public ApiResponse<object> RemoveAuthenticationWithHttpInfo(string documentId, string emailId = null, int? signerOrder = null, string onBehalfOf = null, PhoneNumber phoneNumber = null)

Parameters

documentId string

Gets or sets the document id.

emailId string

Gets or sets the signer email.

signerOrder int?

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

onBehalfOf string

The on behalfof email.

phoneNumber PhoneNumber

The phone number.

Returns

ApiResponse<object>

ApiResponse of Object(void).

Exceptions

ApiException

Thrown when fails to make API call.

RevokeDocument(string, string, string)

Revoke the document with the given document ID.

public void RevokeDocument(string documentId, string revokeMessage, string onBehalfOf = null)

Parameters

documentId string

Document Id.

revokeMessage string

RevokeDetails.

onBehalfOf string

The on behalfof email.

Exceptions

ApiException

Thrown when fails to make API call

RevokeDocumentAsync(string, string, string)

Revoke the document with the given document ID.

public Task RevokeDocumentAsync(string documentId, string revokeMessage, string onBehalfOf = null)

Parameters

documentId string

Document Id.

revokeMessage string

RevokeDetails.

onBehalfOf string

The on behalfof email.

Returns

Task

Task of void

Exceptions

ApiException

Thrown when fails to make API call

RevokeDocumentAsyncWithHttpInfo(string, string, string)

Revoke the document with the given document ID.

public Task<ApiResponse<object>> RevokeDocumentAsyncWithHttpInfo(string documentId, string revokeMessage, string onBehalfOf = null)

Parameters

documentId string

Document Id.

revokeMessage string

RevokeDetails.

onBehalfOf string

The on behalfof email.

Returns

Task<ApiResponse<object>>

Task of ApiResponse

Exceptions

ApiException

Thrown when fails to make API call

RevokeDocumentWithHttpInfo(string, string, string)

Revoke the document with the given document ID.

public ApiResponse<object> RevokeDocumentWithHttpInfo(string documentId, string revokeMessage, string onBehalfOf = null)

Parameters

documentId string

Document Id.

revokeMessage string

RevokeDetails.

onBehalfOf string

The on behalfof email.

Returns

ApiResponse<object>

ApiResponse of Object(void)

Exceptions

ApiException

Thrown when fails to make API call

SendDocument(SendForSign)

Sends the document for sign.

public DocumentCreated SendDocument(SendForSign signRequestDetails)

Parameters

signRequestDetails SendForSign

Returns

DocumentCreated

DocumentCreated

Exceptions

ApiException

Thrown when fails to make API call

SendDocumentAsync(SendForSign)

Sends the document for sign.

public Task<DocumentCreated> SendDocumentAsync(SendForSign signRequestDetails)

Parameters

signRequestDetails SendForSign

Returns

Task<DocumentCreated>

Task of DocumentCreated

Exceptions

ApiException

Thrown when fails to make API call

SendDocumentAsyncWithHttpInfo(SendForSign)

Sends the document for sign.

public Task<ApiResponse<DocumentCreated>> SendDocumentAsyncWithHttpInfo(SendForSign signRequestDetails)

Parameters

signRequestDetails SendForSign

Returns

Task<ApiResponse<DocumentCreated>>

Task of ApiResponse (DocumentCreated)

Exceptions

ApiException

Thrown when fails to make API call

SendDocumentWithHttpInfo(SendForSign)

Sends the document for sign.

public ApiResponse<DocumentCreated> SendDocumentWithHttpInfo(SendForSign signRequestDetails)

Parameters

signRequestDetails SendForSign

Returns

ApiResponse<DocumentCreated>

ApiResponse of DocumentCreated

Exceptions

ApiException

Thrown when fails to make API call