Class DocumentClient
Represents a collection of functions to interact with the API endpoints. The functions perform actions such as sending document to sign, getting document list, deleting a document, downloading audit log, downloading a document, changing access code of the desired signer and so on.
Inheritance
Namespace: BoldSign.Api
Assembly: BoldSign.Api.dll
Syntax
public class DocumentClient : object, IDocumentClient, IApiAccessor
Constructors
| Improve this Doc View SourceDocumentClient()
Initializes a new instance of the DocumentClient class.
Declaration
public DocumentClient()
DocumentClient(ApiClient)
Initializes a new instance of the
Declaration
public DocumentClient(ApiClient apiClient)
Parameters
Type | Name | Description |
---|---|---|
ApiClient | apiClient | An instance of ApiClient |
DocumentClient(Configuration)
Initializes a new instance of the DocumentClient class using Configuration object.
Declaration
public DocumentClient(Configuration configuration = null)
Parameters
Type | Name | Description |
---|---|---|
Configuration | configuration | An instance of Configuration |
DocumentClient(String)
Initializes a new instance of the DocumentClient class.
Declaration
public DocumentClient(string basePath)
Parameters
Type | Name | Description |
---|---|---|
System.String | basePath |
Properties
| Improve this Doc View SourceConfiguration
Gets or sets the configuration object.
Declaration
public Configuration Configuration { get; set; }
Property Value
Type | Description |
---|---|
Configuration | An instance of the Configuration |
ExceptionFactory
Provides a factory method hook for the creation of exceptions.
Declaration
public ExceptionFactory ExceptionFactory { get; set; }
Property Value
Type | Description |
---|---|
ExceptionFactory |
Methods
| Improve this Doc View SourceAddAuthentication(String, String, AuthenticationType, Nullable<Int32>, String, String)
Add Authentication to user.
Declaration
public void AddAuthentication(string documentId, string emailId, AuthenticationType authenticationType, int? signerOrder = null, string newAccessCode = "", string onBehalfOf = null)
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. |
System.String | onBehalfOf | The on behalf of email. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
AddAuthenticationAsync(String, String, AuthenticationType, Nullable<Int32>, String, String)
Add Authentication to user.
Declaration
public async Task AddAuthenticationAsync(string documentId, string emailId, AuthenticationType authenticationType, int? signerOrder = null, string newAccessCode = "", string onBehalfOf = null)
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. |
System.String | onBehalfOf | The on behalf of email. |
Returns
Type | Description |
---|---|
Task | AddAuthentication. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
AddAuthenticationAsyncWithHttpInfo(String, String, AuthenticationType, Nullable<Int32>, String, String)
Add Authentication to user.
Declaration
public async Task<ApiResponse<object>> AddAuthenticationAsyncWithHttpInfo(string documentId, string emailId, AuthenticationType authenticationType, int? signerOrder = null, string newAccessCode = "", string onBehalfOf = null)
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. |
System.String | onBehalfOf | The on behalf of email. |
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, String)
Add Authentication to user.
Declaration
public ApiResponse<object> AddAuthenticationWithHttpInfo(string documentId, string emailId, AuthenticationType authenticationType, int? signerOrder = null, string newAccessCode = "", string onBehalfOf = null)
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. |
System.String | onBehalfOf | The on behalf of email. |
Returns
Type | Description |
---|---|
ApiResponse<System.Object> | ApiResponse of Object(void). |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
AddTag(DocumentTags)
Delete the document when a particular document’s ID is given as input.
Declaration
public void AddTag(DocumentTags addTags)
Parameters
Type | Name | Description |
---|---|---|
DocumentTags | addTags | contains DocumentId and Label Parameter. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
AddTagAsync(DocumentTags)
Add the Tag to the document when a particular document’s ID and TagNames are given as input.
Declaration
public async Task AddTagAsync(DocumentTags addTags)
Parameters
Type | Name | Description |
---|---|---|
DocumentTags | addTags | contains DocumentId and Label Parameter. |
Returns
Type | Description |
---|---|
Task | Task of void. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
AddTagAsyncWithHttpInfo(DocumentTags)
Adding the document's Label when a particular document’s ID and Tag Name is given as input.
Declaration
public Task<ApiResponse<object>> AddTagAsyncWithHttpInfo(DocumentTags addTags)
Parameters
Type | Name | Description |
---|---|---|
DocumentTags | addTags | contains DocumentId and Label Parameter. |
Returns
Type | Description |
---|---|
Task<ApiResponse<System.Object>> | ApiResponse of Object(void). |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
AddTagWithHttpInfo(DocumentTags)
Adding the document's Label when a particular document’s ID and Tag Name is given as input.
Declaration
public ApiResponse<object> AddTagWithHttpInfo(DocumentTags addTags)
Parameters
Type | Name | Description |
---|---|---|
DocumentTags | addTags | contains DocumentId and Label Parameter. |
Returns
Type | Description |
---|---|
ApiResponse<System.Object> | ApiResponse of Object(void). |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
ChangeAccessCode(String, String, String, Nullable<Int32>, String)
Changes the access code for the desired document signer by verifying the email ID of the signer.
Declaration
public void ChangeAccessCode(string documentId, string emailId, string newAccessCode, int? signerOrder = null, string onBehalfOf = 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) |
System.String | onBehalfOf | The on behalfof email. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
ChangeAccessCodeAsync(String, String, String, Nullable<Int32>, String)
Changes the access code for the desired document signer by verifying the email ID of the signer.
Declaration
public async Task ChangeAccessCodeAsync(string documentId, string emailId, string newAccessCode, int? signerOrder = null, string onBehalfOf = 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) |
System.String | onBehalfOf | The on behalfof email. |
Returns
Type | Description |
---|---|
Task | Task of void |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
ChangeAccessCodeAsyncWithHttpInfo(String, String, String, Nullable<Int32>, String)
Changes the access code for the desired document signer by verifying the email ID of the signer.
Declaration
public async Task<ApiResponse<object>> ChangeAccessCodeAsyncWithHttpInfo(string documentId, string emailId, string newAccessCode, int? signerOrder = null, string onBehalfOf = 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) |
System.String | onBehalfOf | The on behalfof email. |
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>, String)
Changes the access code for the desired document signer by verifying the email ID of the signer.
Declaration
public ApiResponse<object> ChangeAccessCodeWithHttpInfo(string documentId, string emailId, string newAccessCode, int? signerOrder = null, string onBehalfOf = 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) |
System.String | onBehalfOf | The on behalfof email. |
Returns
Type | Description |
---|---|
ApiResponse<System.Object> | ApiResponse of Object(void) |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
ChangeRecipient(String, String, String, String, String, Nullable<Int32>, String)
Change recipient details of a document.
Declaration
public void ChangeRecipient(string documentId, string oldSignerEmail, string reason, string newSignerName, string newSignerEmail, int? signerOrder = null, string onBehalfOf = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | documentId | The document id. |
System.String | oldSignerEmail | The signer email. |
System.String | reason | The reason for changing recipient details. |
System.String | newSignerName | The new name of the recipient. |
System.String | newSignerEmail | The new email address of recipient. |
System.Nullable<System.Int32> | signerOrder | The signer order. |
System.String | onBehalfOf | The on behalfof email. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
ChangeRecipientasync(String, String, String, String, String, Nullable<Int32>, String)
Change recipient details of a document.
Declaration
public async Task ChangeRecipientasync(string documentId, string oldSignerEmail, string reason, string newSignerName, string newSignerEmail, int? signerOrder = null, string onBehalfOf = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | documentId | The document id. |
System.String | oldSignerEmail | The signer email. |
System.String | reason | The reason for changing recipient details. |
System.String | newSignerName | The new name of the recipient . |
System.String | newSignerEmail | The new email address of recipient . |
System.Nullable<System.Int32> | signerOrder | The signer order. |
System.String | onBehalfOf | The on behalfof email. |
Returns
Type | Description |
---|---|
Task | A |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
ChangeRecipientasyncWithHttpInfo(String, String, String, String, String, Nullable<Int32>, String)
Change recipient details of a document.
Declaration
public async Task<ApiResponse<object>> ChangeRecipientasyncWithHttpInfo(string documentId, string oldSignerEmail, string reason, string newSignerName, string newSignerEmail, int? signerOrder = null, string onBehalfOf = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | documentId | The document id. |
System.String | oldSignerEmail | The signer email. |
System.String | reason | The reason for changing recipient details. |
System.String | newSignerName | The new name of the recipient . |
System.String | newSignerEmail | The new email address of recipient . |
System.Nullable<System.Int32> | signerOrder | The signer order. |
System.String | onBehalfOf | The on behalfof email. |
Returns
Type | Description |
---|---|
Task<ApiResponse<System.Object>> | ApiResponse of Object(void). |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
ChangeRecipientWithHttpInfo(String, String, String, String, String, Nullable<Int32>, String)
Change recipient details of a document.
Declaration
public ApiResponse<object> ChangeRecipientWithHttpInfo(string documentId, string oldSignerEmail, string reason, string newSignerName, string newSignerEmail, int? signerOrder = null, string onBehalfOf = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | documentId | The document id. |
System.String | oldSignerEmail | The signer email. |
System.String | reason | The reason for changing recipient details. |
System.String | newSignerName | The new name of the recipient. |
System.String | newSignerEmail | The new email address of recipient. |
System.Nullable<System.Int32> | signerOrder | The signer order. |
System.String | onBehalfOf | The on behalfof email. |
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
public EmbeddedSendCreated CreateEmbeddedRequestUrl(EmbeddedDocumentRequest sendRequest)
Parameters
Type | Name | Description |
---|---|---|
EmbeddedDocumentRequest | sendRequest | The signRequestDetails. |
Returns
Type | Description |
---|---|
EmbeddedSendCreated | EmbeddedSendCreated. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
CreateEmbeddedRequestUrlAsync(EmbeddedDocumentRequest)
Generates a send URL which embeds document sending process into your application.
Declaration
public async Task<EmbeddedSendCreated> CreateEmbeddedRequestUrlAsync(EmbeddedDocumentRequest sendRequest)
Parameters
Type | Name | Description |
---|---|---|
EmbeddedDocumentRequest | sendRequest | The signRequestDetails. |
Returns
Type | Description |
---|---|
Task<EmbeddedSendCreated> | Task of EmbeddedSendCreated. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
CreateEmbeddedRequestUrlAsyncWithHttpInfo(EmbeddedDocumentRequest)
Embedded sends the document and generates a URL to embedded that document into iframe.
Declaration
public async Task<ApiResponse<EmbeddedSendCreated>> CreateEmbeddedRequestUrlAsyncWithHttpInfo(EmbeddedDocumentRequest sendRequest)
Parameters
Type | Name | Description |
---|---|---|
EmbeddedDocumentRequest | sendRequest | The signRequestDetails. |
Returns
Type | Description |
---|---|
Task<ApiResponse<EmbeddedSendCreated>> | Task of ApiResponse (EmbeddedSendCreated). |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
CreateEmbeddedRequestUrlWithHttpInfo(EmbeddedDocumentRequest)
Embedded sends the document and generates a URL to embedded that document into iframe.
Declaration
public ApiResponse<EmbeddedSendCreated> CreateEmbeddedRequestUrlWithHttpInfo(EmbeddedDocumentRequest sendRequest)
Parameters
Type | Name | Description |
---|---|---|
EmbeddedDocumentRequest | sendRequest | The signRequestDetails. |
Returns
Type | Description |
---|---|
ApiResponse<EmbeddedSendCreated> | ApiResponse of EmbeddedSendCreated. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
DeleteDocument(String, Boolean)
Delete the document when a particular document’s ID is given as input.
Declaration
public void DeleteDocument(string documentId, bool deletePermanently = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | documentId | Document Id. |
System.Boolean | deletePermanently | if true, the document will be deleted permanently. if false, the document will be moved to the trash. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
DeleteDocumentAsync(String, Boolean)
Delete the document when a particular document’s ID is given as input.
Declaration
public async Task DeleteDocumentAsync(string documentId, bool deletePermanently = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | documentId | Document Id. |
System.Boolean | deletePermanently | if true, the document will be deleted permanently. if false, the document will be moved to the trash. |
Returns
Type | Description |
---|---|
Task | Task of void |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
DeleteDocumentAsyncWithHttpInfo(String, Boolean)
Delete the document when a particular document’s ID is given as input.
Declaration
public async Task<ApiResponse<object>> DeleteDocumentAsyncWithHttpInfo(string documentId, bool deletePermanently = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | documentId | Document Id. |
System.Boolean | deletePermanently | if true, the document will be deleted permanently. if false, the document will be moved to the trash. |
Returns
Type | Description |
---|---|
Task<ApiResponse<System.Object>> | Task of ApiResponse |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
DeleteDocumentWithHttpInfo(String, Boolean)
Delete the document when a particular document’s ID is given as input.
Declaration
public ApiResponse<object> DeleteDocumentWithHttpInfo(string documentId, bool deletePermanently = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | documentId | Document Id. |
System.Boolean | deletePermanently | if true, the document will be deleted permanently. if false, the document will be moved to the trash. |
Returns
Type | Description |
---|---|
ApiResponse<System.Object> | ApiResponse of Object(void) |
Exceptions
Type | Condition |
---|---|
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.
Declaration
public void DeleteTag(DocumentTags deleteTags)
Parameters
Type | Name | Description |
---|---|---|
DocumentTags | deleteTags | contains DocumentId and Label Parameter. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
DeleteTagAsync(DocumentTags)
Delete the document when a particular document’s ID is given as input.
Declaration
public async Task DeleteTagAsync(DocumentTags deleteTags)
Parameters
Type | Name | Description |
---|---|---|
DocumentTags | deleteTags | contains DocumentId and Label Parameter. |
Returns
Type | Description |
---|---|
Task | ApiResponse of Object(void). |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
DeleteTagAsyncWithHttpInfo(DocumentTags)
Adding the document's Label when a particular document’s ID and Tag Name is given as input.
Declaration
public Task<ApiResponse<object>> DeleteTagAsyncWithHttpInfo(DocumentTags deleteTags)
Parameters
Type | Name | Description |
---|---|---|
DocumentTags | deleteTags | contains DocumentId and Label Parameter. |
Returns
Type | Description |
---|---|
Task<ApiResponse<System.Object>> | ApiResponse of Object(void). |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
DeleteTagWithHttpInfo(DocumentTags)
Delete the document when a particular document’s ID is given as input.
Declaration
public ApiResponse<object> DeleteTagWithHttpInfo(DocumentTags deleteTags)
Parameters
Type | Name | Description |
---|---|---|
DocumentTags | deleteTags | contains DocumentId and Label Parameter. |
Returns
Type | Description |
---|---|
ApiResponse<System.Object> | ApiResponse of Object(void). |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
DownloadAttachment(String, String, String)
Download the attachment for given document ID and attachment ID.
Declaration
public Stream DownloadAttachment(string documentId, string attachmentId, string onBehalfOf = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | documentId | Document Id. |
System.String | attachmentId | attachmentId. |
System.String | onBehalfOf | OnBehalfOf Email. |
Returns
Type | Description |
---|---|
Stream | System.IO.Stream. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
DownloadAttachmentAsync(String, String, String)
Download the attachment for given document ID and attachment ID.
Declaration
public async Task<Stream> DownloadAttachmentAsync(string documentId, string attachmentId, string onBehalfOf = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | documentId | Document Id. |
System.String | attachmentId | Attachment Id. |
System.String | onBehalfOf | OnBehalfOf Email. |
Returns
Type | Description |
---|---|
Task<Stream> | Task of System.IO.Stream. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
DownloadAttachmentAsyncWithHttpInfo(String, String, String)
Download the attachment for given document ID and attachment ID.
Declaration
public async Task<ApiResponse<Stream>> DownloadAttachmentAsyncWithHttpInfo(string documentId, string attachmentId, string onBehalfOf = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | documentId | Document Id. |
System.String | attachmentId | Attachment Id. |
System.String | onBehalfOf | OnBehalfOf Email. |
Returns
Type | Description |
---|---|
Task<ApiResponse<Stream>> | Task of ApiResponse (System.IO.Stream). |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
DownloadAttachmenttWithHttpInfo(String, String, String)
Download the attachment for given document ID and attachment ID.
Declaration
public ApiResponse<Stream> DownloadAttachmenttWithHttpInfo(string documentId, string attachmentId, string onBehalfOf = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | documentId | Document Id. |
System.String | attachmentId | attachmentId. |
System.String | onBehalfOf | OnBehalfOf Email. |
Returns
Type | Description |
---|---|
ApiResponse<Stream> | ApiResponse of System.IO.Stream. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
DownloadAuditLog(String, String)
Download the audit trail document for a particular document with given document ID.
Declaration
public Stream DownloadAuditLog(string documentId, string onBehalfOf = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | documentId | Document Id. |
System.String | onBehalfOf | The on behalfof email. |
Returns
Type | Description |
---|---|
Stream | System.IO.Stream |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
DownloadAuditLogAsync(String, String)
Download the audit trail document for a particular document with given document ID.
Declaration
public async Task<Stream> DownloadAuditLogAsync(string documentId, string onBehalfOf = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | documentId | Document Id. |
System.String | onBehalfOf | The on behalfof email. |
Returns
Type | Description |
---|---|
Task<Stream> | Task of System.IO.Stream |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
DownloadAuditLogAsyncWithHttpInfo(String, String)
Download the audit trail document for a particular document with given document ID.
Declaration
public async Task<ApiResponse<Stream>> DownloadAuditLogAsyncWithHttpInfo(string documentId, string onBehalfOf = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | documentId | Document Id. |
System.String | onBehalfOf | The on behalfof email. |
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, String)
Download the audit trail document for a particular document with given document ID.
Declaration
public ApiResponse<Stream> DownloadAuditLogWithHttpInfo(string documentId, string onBehalfOf = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | documentId | Document Id. |
System.String | onBehalfOf | The on behalfof email. |
Returns
Type | Description |
---|---|
ApiResponse<Stream> | ApiResponse of System.IO.Stream |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
DownloadDocument(String, String)
Download the document for given document ID.
Declaration
public Stream DownloadDocument(string documentId, string onBehalfOf = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | documentId | Document Id. |
System.String | onBehalfOf | The on behalfof email. |
Returns
Type | Description |
---|---|
Stream | System.IO.Stream |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
DownloadDocumentAsync(String, String)
Download the document for given document ID.
Declaration
public async Task<Stream> DownloadDocumentAsync(string documentId, string onBehalfOf = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | documentId | Document Id. |
System.String | onBehalfOf | The on behalfof email. |
Returns
Type | Description |
---|---|
Task<Stream> | Task of System.IO.Stream |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
DownloadDocumentAsyncWithHttpInfo(String, String)
Download the document for given document ID.
Declaration
public async Task<ApiResponse<Stream>> DownloadDocumentAsyncWithHttpInfo(string documentId, string onBehalfOf = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | documentId | Document Id. |
System.String | onBehalfOf | The on behalfof email. |
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, String)
Download the document for given document ID.
Declaration
public ApiResponse<Stream> DownloadDocumentWithHttpInfo(string documentId, string onBehalfOf = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | documentId | Document Id. |
System.String | onBehalfOf | The on behalf of email. |
Returns
Type | Description |
---|---|
ApiResponse<Stream> | ApiResponse of System.IO.Stream |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
ExtendExpiry(String, String, Nullable<Boolean>, String)
Extends the expiration date of the document.
Declaration
public void ExtendExpiry(string documentId, string newExpiryValue, bool? warnPrior = null, string onBehalfOf = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | documentId | The Document ID. |
System.String | newExpiryValue | 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. |
System.Nullable<System.Boolean> | warnPrior | 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. |
System.String | onBehalfOf | The on behalfof email. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
ExtendExpiryAsync(String, String, Nullable<Boolean>, String)
Extends the expiration date of the document.
Declaration
public async Task ExtendExpiryAsync(string documentId, string newExpiryValue, bool? warnPrior = null, string onBehalfOf = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | documentId | The Document ID. |
System.String | newExpiryValue | 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. |
System.Nullable<System.Boolean> | warnPrior | 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. |
System.String | onBehalfOf | The on behalfof email. |
Returns
Type | Description |
---|---|
Task |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
ExtendExpiryAsyncWithHttpInfo(String, String, Nullable<Boolean>, String)
Extends the expiration date of the document.
Declaration
public async Task<ApiResponse<object>> ExtendExpiryAsyncWithHttpInfo(string documentId, string newExpiryValue, bool? warnPrior = null, string onBehalfOf = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | documentId | The Document ID. |
System.String | newExpiryValue | 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. |
System.Nullable<System.Boolean> | warnPrior | 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. |
System.String | onBehalfOf | The on behalfof email. |
Returns
Type | Description |
---|---|
Task<ApiResponse<System.Object>> | Task of ApiResponse. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
ExtendExpiryWithHttpinfo(String, String, Nullable<Boolean>, String)
Extends the expiration date of the document.
Declaration
public ApiResponse<object> ExtendExpiryWithHttpinfo(string documentId, string newExpiryValue, bool? warnPrior = null, string onBehalfOf = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | documentId | The Document ID. |
System.String | newExpiryValue | 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. |
System.Nullable<System.Boolean> | warnPrior | 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. |
System.String | onBehalfOf | The on behalfof email. |
Returns
Type | Description |
---|---|
ApiResponse<System.Object> | ApiResponse of Object(void). |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
GetBasePath()
Gets the base path of the API client.
Declaration
public string GetBasePath()
Returns
Type | Description |
---|---|
System.String | The base path |
GetEmbeddedSignLink(String, String, Nullable<DateTime>, String)
Get sign link in a mail for Embedded Sign to given Email ID. The link has expiry time. This method can also be used to send a redirect URL.
Declaration
public EmbeddedSigningLink GetEmbeddedSignLink(string documentId, string signerEmail, DateTime? signLinkValidTill = null, string redirectUrl = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | documentId | Gets or sets Document Id. |
System.String | signerEmail | Gets or sets signer email. |
System.Nullable<DateTime> | signLinkValidTill | Gets or sets sign link expiration date (Valid Till). (optional) |
System.String | redirectUrl | Gets or sets Redirect URL. (optional) |
Returns
Type | Description |
---|---|
EmbeddedSigningLink | EmbeddedSigningLink |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetEmbeddedSignLinkAsync(String, String, Nullable<DateTime>, String)
Get sign link in a mail for Embedded Sign to given Email ID. The link has expiry time. This method can also be used to send a redirect URL.
Declaration
public async Task<EmbeddedSigningLink> GetEmbeddedSignLinkAsync(string documentId, string signerEmail, DateTime? signLinkValidTill = null, string redirectUrl = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | documentId | Gets or sets Document Id. |
System.String | signerEmail | Gets or sets signer email. |
System.Nullable<DateTime> | signLinkValidTill | Gets or sets sign link expiration date (Valid Till). (optional) |
System.String | redirectUrl | Gets or sets Redirect URL. (optional) |
Returns
Type | Description |
---|---|
Task<EmbeddedSigningLink> | Task of EmbeddedSigningLink |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetEmbeddedSignLinkAsyncWithHttpInfo(String, String, Nullable<DateTime>, String)
Get sign link in a mail for Embedded Sign to given Email ID. The link has expiry time. This method can also be used to send a redirect URL.
Declaration
public async Task<ApiResponse<EmbeddedSigningLink>> GetEmbeddedSignLinkAsyncWithHttpInfo(string documentId, string signerEmail, DateTime? signLinkValidTill = null, string redirectUrl = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | documentId | Gets or sets Document Id. |
System.String | signerEmail | Gets or sets signer email. |
System.Nullable<DateTime> | signLinkValidTill | Gets or sets sign link expiration date (Valid Till). (optional) |
System.String | redirectUrl | Gets or sets Redirect URL. (optional) |
Returns
Type | Description |
---|---|
Task<ApiResponse<EmbeddedSigningLink>> | Task of ApiResponse (EmbeddedSigningLink) |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetEmbeddedSignLinkWithHttpInfo(String, String, Nullable<DateTime>, String)
Get sign link in a mail for Embedded Sign to given Email ID. The link has expiry time. This method can also be used to send a redirect URL.
Declaration
public ApiResponse<EmbeddedSigningLink> GetEmbeddedSignLinkWithHttpInfo(string documentId, string signerEmail, DateTime? signLinkValidTill = null, string redirectUrl = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | documentId | Gets or sets Document Id. |
System.String | signerEmail | Gets or sets signer email. |
System.Nullable<DateTime> | signLinkValidTill | Gets or sets sign link expiration date (Valid Till). (optional) |
System.String | redirectUrl | Gets or sets Redirect URL. (optional) |
Returns
Type | Description |
---|---|
ApiResponse<EmbeddedSigningLink> | ApiResponse of EmbeddedSigningLink |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetProperties(String)
Get summary of the document for the given document ID.
Declaration
public DocumentProperties GetProperties(string documentId)
Parameters
Type | Name | Description |
---|---|---|
System.String | documentId | Document Id. |
Returns
Type | Description |
---|---|
DocumentProperties | DocumentProperties |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetPropertiesAsync(String)
Get summary of the document for the given document ID.
Declaration
public async Task<DocumentProperties> GetPropertiesAsync(string documentId)
Parameters
Type | Name | Description |
---|---|---|
System.String | documentId | Document Id. |
Returns
Type | Description |
---|---|
Task<DocumentProperties> | Task of DocumentProperties |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetPropertiesAsyncWithHttpInfo(String)
Get summary of the document for the given document ID.
Declaration
public async Task<ApiResponse<DocumentProperties>> GetPropertiesAsyncWithHttpInfo(string documentId)
Parameters
Type | Name | Description |
---|---|---|
System.String | documentId | Document Id. |
Returns
Type | Description |
---|---|
Task<ApiResponse<DocumentProperties>> | Task of ApiResponse (DocumentProperties) |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetPropertiesWithHttpInfo(String)
Get summary of the document for the given document ID.
Declaration
public ApiResponse<DocumentProperties> GetPropertiesWithHttpInfo(string documentId)
Parameters
Type | Name | Description |
---|---|---|
System.String | documentId | Document Id. |
Returns
Type | Description |
---|---|
ApiResponse<DocumentProperties> | ApiResponse of DocumentProperties |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
ListBehalfDocuments(Int32, Nullable<Int32>, List<String>, List<Status>, String, Nullable<PageType>, Nullable<DateTime>, Nullable<DateTime>, List<String>, List<String>)
List of behalf documents which can be filtered by status, page size and so on.
Declaration
public BehalfDocumentRecords ListBehalfDocuments(int page, 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)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | page | Gets or sets the page index specified in get document list request. |
System.Nullable<System.Int32> | pageSize | Gets or sets the page size specified in get document list request. (optional, default to 10). |
List<System.String> | emailAddress | 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). |
List<Status> | status | Gets or sets the status used to filter documents based on their current status, including In-progress, Completed, Declined, Expired, and Revoked. (optional). |
System.String | searchKey | 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). |
System.Nullable<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). |
System.Nullable<DateTime> | startDate | 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). |
System.Nullable<DateTime> | endDate | 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). |
List<System.String> | signers | 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). |
List<System.String> | labels | 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). |
Returns
Type | Description |
---|---|
BehalfDocumentRecords | BehalfDocumentRecords. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
ListBehalfDocumentsAsync(Int32, Nullable<Int32>, List<String>, List<Status>, String, Nullable<PageType>, Nullable<DateTime>, Nullable<DateTime>, List<String>, List<String>)
List of behalf documents which can be filtered by status, page size and so on.
Declaration
public async Task<BehalfDocumentRecords> ListBehalfDocumentsAsync(int page, 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)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | page | Gets or sets the page index specified in get document list request. |
System.Nullable<System.Int32> | pageSize | Gets or sets the page size specified in get document list request. (optional, default to 10). |
List<System.String> | emailAddress | 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). |
List<Status> | status | Gets or sets the status used to filter documents based on their current status, including In-progress, Completed, Declined, Expired, and Revoked. (optional). |
System.String | searchKey | 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). |
System.Nullable<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). |
System.Nullable<DateTime> | startDate | 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). |
System.Nullable<DateTime> | endDate | 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). |
List<System.String> | signers | 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). |
List<System.String> | labels | 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). |
Returns
Type | Description |
---|---|
Task<BehalfDocumentRecords> | Task of BehalfDocumentRecords. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
ListBehalfDocumentsAsyncWithHttpInfo(Int32, Nullable<Int32>, List<String>, List<Status>, String, Nullable<PageType>, Nullable<DateTime>, Nullable<DateTime>, List<String>, List<String>)
List of behalf documents which can be filtered by status, page size and so on.
Declaration
public async Task<ApiResponse<BehalfDocumentRecords>> ListBehalfDocumentsAsyncWithHttpInfo(int page, 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)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | page | Gets or sets the page index specified in get document list request. |
System.Nullable<System.Int32> | pageSize | Gets or sets the page size specified in get document list request. (optional, default to 10). |
List<System.String> | emailAddress | 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). |
List<Status> | status | Gets or sets the status used to filter documents based on their current status, including In-progress, Completed, Declined, Expired, and Revoked. (optional). |
System.String | searchKey | 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). |
System.Nullable<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). |
System.Nullable<DateTime> | startDate | 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). |
System.Nullable<DateTime> | endDate | 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). |
List<System.String> | signers | 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). |
List<System.String> | labels | 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). |
Returns
Type | Description |
---|---|
Task<ApiResponse<BehalfDocumentRecords>> | Task of ApiResponse (BehalfDocumentRecords). |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
ListBehalfDocumentsWithHttpInfo(Int32, Nullable<Int32>, List<String>, List<Status>, String, Nullable<PageType>, Nullable<DateTime>, Nullable<DateTime>, List<String>, List<String>)
List of behalf documents which can be filtered by status, page size and so on.
Declaration
public ApiResponse<BehalfDocumentRecords> ListBehalfDocumentsWithHttpInfo(int page, 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)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | page | Gets or sets the page index specified in get document list request. |
System.Nullable<System.Int32> | pageSize | Gets or sets the page size specified in get document list request. (optional, default to 10). |
List<System.String> | emailAddress | 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). |
List<Status> | status | Gets or sets the status used to filter documents based on their current status, including In-progress, Completed, Declined, Expired, and Revoked. (optional). |
System.String | searchKey | 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). |
System.Nullable<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). |
System.Nullable<DateTime> | startDate | 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). |
System.Nullable<DateTime> | endDate | 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). |
List<System.String> | signers | 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). |
List<System.String> | labels | 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). |
Returns
Type | Description |
---|---|
ApiResponse<BehalfDocumentRecords> | ApiResponse of BehalfDocumentRecords. |
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
public DocumentRecords ListDocuments(int page, int? pageSize = null, List<string> sentBy = null, List<string> recipients = null, DateTime? startDate = null, List<Status> status = null, DateTime? endDate = null, string searchKey = null, List<string> labels = null, TransmitType? transmitType = null)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | page | Gets or sets the page. |
System.Nullable<System.Int32> | pageSize | Gets or sets the page size. (optional, default to 10) |
List<System.String> | sentBy | Gets or sets the documentId. (optional) |
List<System.String> | recipients | Gets or sets the recipients. (optional) |
System.Nullable<DateTime> | startDate | Gets or sets the start date. (optional) |
List<Status> | status | Gets or sets the status. (optional) |
System.Nullable<DateTime> | endDate | Gets or sets the endDate. (optional) |
System.String | searchKey | Gets or sets the searchKey. (optional) |
List<System.String> | labels | |
System.Nullable<TransmitType> | transmitType |
Returns
Type | Description |
---|---|
DocumentRecords | DocumentRecords |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
ListDocumentsAsync(Int32, Nullable<Int32>, List<String>, List<String>, Nullable<DateTime>, List<Status>, Nullable<DateTime>, String, List<String>, Nullable<TransmitType>)
List all user documents which can be filtered by date, time, sender, status, and so on.
Declaration
public async Task<DocumentRecords> ListDocumentsAsync(int page, int? pageSize = null, List<string> sentBy = null, List<string> recipients = null, DateTime? startDate = null, List<Status> status = null, DateTime? endDate = null, string searchKey = null, List<string> labels = null, TransmitType? transmitType = null)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | page | Gets or sets the page. |
System.Nullable<System.Int32> | pageSize | Gets or sets the page size. (optional, default to 10) |
List<System.String> | sentBy | Gets or sets the documentId. (optional) |
List<System.String> | recipients | Gets or sets the recipients. (optional) |
System.Nullable<DateTime> | startDate | Gets or sets the start date. (optional) |
List<Status> | status | Gets or sets the status. (optional) |
System.Nullable<DateTime> | endDate | Gets or sets the endDate. (optional) |
System.String | searchKey | Gets or sets the searchKey. (optional) |
List<System.String> | labels | |
System.Nullable<TransmitType> | transmitType |
Returns
Type | Description |
---|---|
Task<DocumentRecords> | Task of DocumentRecords |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
ListDocumentsAsyncWithHttpInfo(Int32, Nullable<Int32>, List<String>, List<String>, Nullable<DateTime>, List<Status>, Nullable<DateTime>, String, List<String>, Nullable<TransmitType>)
List all user documents which can be filtered by date, time, sender, status, and so on.
Declaration
public async Task<ApiResponse<DocumentRecords>> ListDocumentsAsyncWithHttpInfo(int page, int? pageSize = null, List<string> sentBy = null, List<string> recipients = null, DateTime? startDate = null, List<Status> status = null, DateTime? endDate = null, string searchKey = null, List<string> labels = null, TransmitType? transmitType = null)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | page | Gets or sets the page. |
System.Nullable<System.Int32> | pageSize | Gets or sets the page size. (optional, default to 10) |
List<System.String> | sentBy | Gets or sets the documentId. (optional) |
List<System.String> | recipients | Gets or sets the recipients. (optional) |
System.Nullable<DateTime> | startDate | Gets or sets the start date. (optional) |
List<Status> | status | Gets or sets the status. (optional) |
System.Nullable<DateTime> | endDate | Gets or sets the endDate. (optional) |
System.String | searchKey | Gets or sets the searchKey. (optional) |
List<System.String> | labels | |
System.Nullable<TransmitType> | transmitType |
Returns
Type | Description |
---|---|
Task<ApiResponse<DocumentRecords>> | Task of ApiResponse (DocumentRecords) |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
ListDocumentsWithHttpInfo(Int32, Nullable<Int32>, List<String>, List<String>, Nullable<DateTime>, List<Status>, Nullable<DateTime>, String, List<String>, Nullable<TransmitType>)
List all user documents which can be filtered by date, time, sender, status, and so on.
Declaration
public ApiResponse<DocumentRecords> ListDocumentsWithHttpInfo(int page, int? pageSize = null, List<string> sentBy = null, List<string> recipients = null, DateTime? startDate = null, List<Status> status = null, DateTime? endDate = null, string searchKey = null, List<string> labels = null, TransmitType? transmitType = null)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | page | Gets or sets the page. |
System.Nullable<System.Int32> | pageSize | Gets or sets the page size. (optional, default to 10) |
List<System.String> | sentBy | Gets or sets the documentId. (optional) |
List<System.String> | recipients | Gets or sets the recipients. (optional) |
System.Nullable<DateTime> | startDate | Gets or sets the start date. (optional) |
List<Status> | status | Gets or sets the status. (optional) |
System.Nullable<DateTime> | endDate | Gets or sets the endDate. (optional) |
System.String | searchKey | Gets or sets the searchKey. (optional) |
List<System.String> | labels | |
System.Nullable<TransmitType> | transmitType |
Returns
Type | Description |
---|---|
ApiResponse<DocumentRecords> | ApiResponse of DocumentRecords |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
ListTeamDocuments(Int32, Nullable<Int32>, Nullable<DateTime>, List<Status>, List<String>, List<String>, Nullable<DateTime>, String, List<String>, Nullable<TransmitType>)
List all user team documents which can be filtered by date, time, teamid, userid, status, and so on.
Declaration
public TeamDocumentRecords ListTeamDocuments(int page, int? pageSize = null, DateTime? startDate = null, List<Status> status = null, List<string> teamId = null, List<string> userId = null, DateTime? endDate = null, string searchKey = null, List<string> labels = null, TransmitType? transmitType = null)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | page | Gets or sets the page. |
System.Nullable<System.Int32> | pageSize | Gets or sets the page size. (optional, default to 10). |
System.Nullable<DateTime> | startDate | Gets or sets the start date. (optional). |
List<Status> | status | Gets or sets the status. (optional). |
List<System.String> | teamId | Gets or sets the teamId. (optional). |
List<System.String> | userId | Gets or sets the userId. (optional). |
System.Nullable<DateTime> | endDate | Gets or sets the endDate. (optional). |
System.String | searchKey | Gets or sets the searchKey. (optional). |
List<System.String> | labels | Gets or set the labels. |
System.Nullable<TransmitType> | transmitType | transmitType. |
Returns
Type | Description |
---|---|
TeamDocumentRecords | ApiResponse of TeamDocumentRecords. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
ListTeamDocumentsAsync(Int32, Nullable<Int32>, Nullable<DateTime>, List<Status>, List<String>, List<String>, Nullable<DateTime>, String, List<String>, Nullable<TransmitType>)
List all user team documents which can be filtered by date, time, teamid, userid, status, and so on.
Declaration
public async Task<TeamDocumentRecords> ListTeamDocumentsAsync(int page, int? pageSize = null, DateTime? startDate = null, List<Status> status = null, List<string> teamId = null, List<string> userId = null, DateTime? endDate = null, string searchKey = null, List<string> labels = null, TransmitType? transmitType = null)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | page | Gets or sets the page. |
System.Nullable<System.Int32> | pageSize | Gets or sets the page size. (optional, default to 10). |
System.Nullable<DateTime> | startDate | Gets or sets the start date. (optional). |
List<Status> | status | Gets or sets the status. (optional). |
List<System.String> | teamId | Gets or sets the teamId. (optional). |
List<System.String> | userId | Gets or sets the userId. (optional). |
System.Nullable<DateTime> | endDate | Gets or sets the endDate. (optional). |
System.String | searchKey | Gets or sets the searchKey. (optional). |
List<System.String> | labels | Gets or set the labels. |
System.Nullable<TransmitType> | transmitType | transmitType. |
Returns
Type | Description |
---|---|
Task<TeamDocumentRecords> | Task of TeamDocumentRecords. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
ListTeamDocumentsAsyncWithHttpInfo(Int32, Nullable<Int32>, Nullable<DateTime>, List<Status>, List<String>, List<String>, Nullable<DateTime>, String, List<String>, Nullable<TransmitType>)
List all user team documents which can be filtered by date, time, teamid, userid, status, and so on.
Declaration
public async Task<ApiResponse<TeamDocumentRecords>> ListTeamDocumentsAsyncWithHttpInfo(int page, int? pageSize = null, DateTime? startDate = null, List<Status> status = null, List<string> teamId = null, List<string> userId = null, DateTime? endDate = null, string searchKey = null, List<string> labels = null, TransmitType? transmitType = null)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | page | Gets or sets the page. |
System.Nullable<System.Int32> | pageSize | Gets or sets the page size. (optional, default to 10). |
System.Nullable<DateTime> | startDate | Gets or sets the start date. (optional). |
List<Status> | status | Gets or sets the status. (optional). |
List<System.String> | teamId | Gets or sets the teamId. (optional). |
List<System.String> | userId | Gets or sets the userId. (optional). |
System.Nullable<DateTime> | endDate | Gets or sets the endDate. (optional). |
System.String | searchKey | Gets or sets the searchKey. (optional). |
List<System.String> | labels | Gets or set the labels. |
System.Nullable<TransmitType> | transmitType | transmitType. |
Returns
Type | Description |
---|---|
Task<ApiResponse<TeamDocumentRecords>> | Task of ApiResponse (TeamDocumentRecords). |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
ListTeamDocumentsWithHttpInfo(Int32, Nullable<Int32>, Nullable<DateTime>, List<Status>, List<String>, List<String>, Nullable<DateTime>, String, List<String>, Nullable<TransmitType>)
List all user team documents which can be filtered by date, time, teamid, userid, status, and so on.
Declaration
public ApiResponse<TeamDocumentRecords> ListTeamDocumentsWithHttpInfo(int page, int? pageSize = null, DateTime? startDate = null, List<Status> status = null, List<string> teamId = null, List<string> userId = null, DateTime? endDate = null, string searchKey = null, List<string> labels = null, TransmitType? transmitType = null)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | page | Gets or sets the page. |
System.Nullable<System.Int32> | pageSize | Gets or sets the page size. (optional, default to 10). |
System.Nullable<DateTime> | startDate | Gets or sets the start date. (optional). |
List<Status> | status | Gets or sets the status. (optional). |
List<System.String> | teamId | Gets or sets the teamId. (optional). |
List<System.String> | userId | Gets or sets the userId. (optional). |
System.Nullable<DateTime> | endDate | Gets or sets the endDate. (optional). |
System.String | searchKey | Gets or sets the searchKey. (optional). |
List<System.String> | labels | Gets or set the labels. |
System.Nullable<TransmitType> | transmitType | transmitType. |
Returns
Type | Description |
---|---|
ApiResponse<TeamDocumentRecords> | ApiResponse of TeamDocumentRecords. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
RemindDocument(String, List<String>, ReminderMessage)
Send a reminder message to pending signers for a particular document to their respective email IDs.
Declaration
public void RemindDocument(string documentId, List<string> receiverEmails = null, ReminderMessage reminderMessage = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | documentId | Document Id. |
List<System.String> | receiverEmails | Signer emails. |
ReminderMessage | reminderMessage | Reminder Message for signers. (optional) |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
RemindDocumentAsync(String, List<String>, ReminderMessage)
Send a reminder message to pending signers for a particular document to their respective email IDs.
Declaration
public async Task RemindDocumentAsync(string documentId, List<string> receiverEmails = null, ReminderMessage reminderMessage = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | documentId | Document Id. |
List<System.String> | receiverEmails | Signer emails. |
ReminderMessage | reminderMessage | Reminder Message for signers. (optional) |
Returns
Type | Description |
---|---|
Task | Task of void |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
RemindDocumentAsyncWithHttpInfo(String, List<String>, ReminderMessage)
Send a reminder message to pending signers for a particular document to their respective email IDs.
Declaration
public async Task<ApiResponse<object>> RemindDocumentAsyncWithHttpInfo(string documentId, List<string> receiverEmails = null, ReminderMessage reminderMessage = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | documentId | Document Id. |
List<System.String> | receiverEmails | Signer emails. |
ReminderMessage | reminderMessage | Reminder Message for signers. (optional) |
Returns
Type | Description |
---|---|
Task<ApiResponse<System.Object>> | Task of ApiResponse |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
RemindDocumentWithHttpInfo(String, List<String>, ReminderMessage)
Send a reminder message to pending signers for a particular document to their respective email IDs.
Declaration
public ApiResponse<object> RemindDocumentWithHttpInfo(string documentId, List<string> receiverEmails = null, ReminderMessage reminderMessage = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | documentId | Document Id. |
List<System.String> | receiverEmails | Signer emails. |
ReminderMessage | reminderMessage | Reminder Message for signers. (optional) |
Returns
Type | Description |
---|---|
ApiResponse<System.Object> | ApiResponse of Object(void) |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
RemoveAuthentication(String, String, Nullable<Int32>, String)
Removes the access code for the desired document signer by verifying the email ID of the signer.
Declaration
public void RemoveAuthentication(string documentId, string emailId, int? signerOrder = null, string onBehalfOf = 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). |
System.String | onBehalfOf | The on behalfof email. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
RemoveAuthenticationAsync(String, String, Nullable<Int32>, String)
Removes the access code for the desired document signer by verifying the email ID of the signer.
Declaration
public async Task RemoveAuthenticationAsync(string documentId, string emailId, int? signerOrder = null, string onBehalfOf = 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). |
System.String | onBehalfOf | The on behalfof email. |
Returns
Type | Description |
---|---|
Task | Task of void. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
RemoveAuthenticationAsyncWithHttpInfo(String, String, Nullable<Int32>, String)
Changes the access code for the desired document signer by verifying the email ID of the signer.
Declaration
public async Task<ApiResponse<object>> RemoveAuthenticationAsyncWithHttpInfo(string documentId, string emailId, int? signerOrder = null, string onBehalfOf = 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). |
System.String | onBehalfOf | The on behalfof email. |
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>, String)
Declaration
public ApiResponse<object> RemoveAuthenticationWithHttpInfo(string documentId, string emailId, int? signerOrder = null, string onBehalfOf = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | documentId | |
System.String | emailId | |
System.Nullable<System.Int32> | signerOrder | |
System.String | onBehalfOf |
Returns
Type | Description |
---|---|
ApiResponse<System.Object> | ApiResponse of Object(void). |
RevokeDocument(String, String, String)
Revoke the document with the given document ID.
Declaration
public void RevokeDocument(string documentId, string revokeMessage, string onBehalfOf = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | documentId | Document Id. |
System.String | revokeMessage | RevokeDetails. |
System.String | onBehalfOf | The on behalfof email. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
RevokeDocumentAsync(String, String, String)
Revoke the document with the given document ID.
Declaration
public async Task RevokeDocumentAsync(string documentId, string revokeMessage, string onBehalfOf = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | documentId | Document Id. |
System.String | revokeMessage | RevokeDetails. |
System.String | onBehalfOf | The on behalfof email. |
Returns
Type | Description |
---|---|
Task | Task of void |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
RevokeDocumentAsyncWithHttpInfo(String, String, String)
Revoke the document with the given document ID.
Declaration
public async Task<ApiResponse<object>> RevokeDocumentAsyncWithHttpInfo(string documentId, string revokeMessage, string onBehalfOf = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | documentId | Document Id. |
System.String | revokeMessage | RevokeDetails. |
System.String | onBehalfOf | The on behalfof email. |
Returns
Type | Description |
---|---|
Task<ApiResponse<System.Object>> | Task of ApiResponse |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
RevokeDocumentWithHttpInfo(String, String, String)
Revoke the document with the given document ID.
Declaration
public ApiResponse<object> RevokeDocumentWithHttpInfo(string documentId, string revokeMessage, string onBehalfOf = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | documentId | Document Id. |
System.String | revokeMessage | RevokeDetails. |
System.String | onBehalfOf | The on behalfof email. |
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
public DocumentCreated SendDocument(SendForSign signRequestDetails)
Parameters
Type | Name | Description |
---|---|---|
SendForSign | signRequestDetails |
Returns
Type | Description |
---|---|
DocumentCreated | DocumentCreated |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
SendDocumentAsync(SendForSign)
Sends the document for sign.
Declaration
public async Task<DocumentCreated> SendDocumentAsync(SendForSign signRequestDetails)
Parameters
Type | Name | Description |
---|---|---|
SendForSign | signRequestDetails |
Returns
Type | Description |
---|---|
Task<DocumentCreated> | Task of DocumentCreated |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
SendDocumentAsyncWithHttpInfo(SendForSign)
Sends the document for sign.
Declaration
public async Task<ApiResponse<DocumentCreated>> SendDocumentAsyncWithHttpInfo(SendForSign signRequestDetails)
Parameters
Type | Name | Description |
---|---|---|
SendForSign | signRequestDetails |
Returns
Type | Description |
---|---|
Task<ApiResponse<DocumentCreated>> | Task of ApiResponse (DocumentCreated) |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
SendDocumentWithHttpInfo(SendForSign)
Sends the document for sign.
Declaration
public ApiResponse<DocumentCreated> SendDocumentWithHttpInfo(SendForSign signRequestDetails)
Parameters
Type | Name | Description |
---|---|---|
SendForSign | signRequestDetails |
Returns
Type | Description |
---|---|
ApiResponse<DocumentCreated> | ApiResponse of DocumentCreated |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |