Interface IDocumentClient
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.
Inherited Members
Namespace: BoldSign.Api
Assembly: BoldSign.Api.dll
Syntax
public interface IDocumentClient : IApiAccessor
Methods
| Improve this Doc View SourceAddAuthentication(String, String, AuthenticationType, Nullable<Int32>, String)
Add Authentication to user.
Declaration
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. |
AddAuthenticationAsync(String, String, AuthenticationType, Nullable<Int32>, String)
Add Authentication to user.
Declaration
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. |
AddAuthenticationAsyncWithHttpInfo(String, String, AuthenticationType, Nullable<Int32>, String)
Add Authentication to user.
Declaration
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. |
AddAuthenticationWithHttpInfo(String, String, AuthenticationType, Nullable<Int32>, String)
Add Authentication to user.
Declaration
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. |
ChangeAccessCode(String, String, String, Nullable<Int32>)
Changes the access code for the desired document signer by verifying the email ID of the signer.
Declaration
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 |
ChangeAccessCodeAsync(String, String, String, Nullable<Int32>)
Changes the access code for the desired document signer by verifying the email ID of the signer.
Declaration
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 |
ChangeAccessCodeAsyncWithHttpInfo(String, String, String, Nullable<Int32>)
Changes the access code for the desired document signer by verifying the email ID of the signer.
Declaration
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 |
ChangeAccessCodeWithHttpInfo(String, String, String, Nullable<Int32>)
Changes the access code for the desired document signer by verifying the email ID of the signer.
Declaration
ApiResponse<object> ChangeAccessCodeWithHttpInfo(string documentId, string emailId, string newAccessCode, int? zOrder = 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> | zOrder | 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 |
CreateEmbeddedRequestUrl(EmbeddedDocumentRequest)
Embedded sends the document and generates a URL to embedded that document into iframe.
Declaration
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. |
CreateEmbeddedRequestUrlAsync(EmbeddedDocumentRequest)
Generates a send URL which embeds document sending process into your application.
Declaration
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. |
CreateEmbeddedRequestUrlAsyncWithHttpInfo(EmbeddedDocumentRequest)
Embedded sends the document and generates a URL to embedded that document into iframe.
Declaration
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. |
CreateEmbeddedRequestUrlWithHttpInfo(EmbeddedDocumentRequest)
Embedded sends the document and generates a URL to embedded that document into iframe.
Declaration
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. |
DeleteDocument(String)
Delete the document when a particular document’s ID is given as input.
Declaration
void DeleteDocument(string documentId)
Parameters
Type | Name | Description |
---|---|---|
System.String | documentId | Document Id. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
DeleteDocumentAsync(String)
Delete the document.
Declaration
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 |
DeleteDocumentAsyncWithHttpInfo(String)
Delete the document.
Declaration
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 |
DeleteDocumentWithHttpInfo(String)
Delete the document when a particular document’s ID is given as input.
Declaration
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 |
DownloadAuditLog(String)
Download the audit trail document for a particular document with given document ID.
Declaration
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 |
DownloadAuditLogAsync(String)
Download the audit trail document for a particular document with given document ID.
Declaration
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 |
DownloadAuditLogAsyncWithHttpInfo(String)
Download the audit trail document for a particular document with given document ID.
Declaration
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 |
DownloadAuditLogWithHttpInfo(String)
Download the audit trail document for a particular document with given document ID.
Declaration
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 |
DownloadDocument(String)
Download the document for given document ID.
Declaration
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 |
DownloadDocumentAsync(String)
Download the document for given document ID.
Declaration
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 |
DownloadDocumentAsyncWithHttpInfo(String)
Download the document for given document ID.
Declaration
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 |
DownloadDocumentWithHttpInfo(String)
Download the document for given document ID.
Declaration
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 |
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
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 |
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
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 |
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
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 |
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
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 |
GetProperties(String)
Get summary of the document for the given document ID.
Declaration
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 |
GetPropertiesAsync(String)
Get summary of the document for the given document ID.
Declaration
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 |
GetPropertiesAsyncWithHttpInfo(String)
Get summary of the document for the given document ID.
Declaration
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 |
GetPropertiesWithHttpInfo(String)
Get summary of the document for the given document ID.
Declaration
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 |
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
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 |
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
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 |
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
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 |
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
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 |
RemindDocument(String, List<String>, ReminderMessage)
Send a reminder message to pending signers for a particular document to their respective email IDs.
Declaration
void RemindDocument(string documentId, List<string> receiverEmails, 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 |
RemindDocumentAsync(String, List<String>, ReminderMessage)
Send a reminder message to pending signers for a particular document to their respective email IDs.
Declaration
Task RemindDocumentAsync(string documentId, List<string> receiverEmails, 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 |
RemindDocumentAsyncWithHttpInfo(String, List<String>, ReminderMessage)
Send a reminder message to pending signers for a particular document to their respective email IDs.
Declaration
Task<ApiResponse<object>> RemindDocumentAsyncWithHttpInfo(string documentId, List<string> receiverEmails, 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 |
RemindDocumentWithHttpInfo(String, List<String>, ReminderMessage)
Send a reminder message to pending signers for a particular document to their respective email IDs.
Declaration
ApiResponse<object> RemindDocumentWithHttpInfo(string documentId, List<string> receiverEmails, 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 |
RemoveAuthentication(String, String, Nullable<Int32>)
Remove Authentication to user.
Declaration
void RemoveAuthentication(string documentId, string emailId, int? signerOrder = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | documentId | DocumentId. |
System.String | emailId | EmailID. |
System.Nullable<System.Int32> | signerOrder | SignerOrder. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
RemoveAuthenticationAsync(String, String, Nullable<Int32>)
Remove Authentication to user.
Declaration
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 |
RemoveAuthenticationAsyncWithHttpInfo(String, String, Nullable<Int32>)
Remove Authentication to user.
Declaration
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 |
RemoveAuthenticationWithHttpInfo(String, String, Nullable<Int32>)
Remove Authentication to user.
Declaration
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 |
Returns
Type | Description |
---|---|
ApiResponse<System.Object> | ApiResponse of Object(void) |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
RevokeDocument(String, String)
Revoke the document with the given document ID.
Declaration
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 |
RevokeDocumentAsync(String, String)
Revoke the document with the given document ID.
Declaration
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 |
RevokeDocumentAsyncWithHttpInfo(String, String)
Revoke the document with the given document ID.
Declaration
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 |
RevokeDocumentWithHttpInfo(String, String)
Revoke the document with the given document ID.
Declaration
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 |
SendDocument(SendForSign)
Sends the document for sign.
Declaration
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 |
SendDocumentAsync(SendForSign)
Sends the document for sign.
Declaration
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 |
SendDocumentAsyncWithHttpInfo(SendForSign)
Sends the document for sign.
Declaration
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 |
SendDocumentWithHttpInfo(SendForSign)
Sends the document for sign.
Declaration
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 |