Class DocumentEvent

Namespace

BoldSign.Model.Webhook

Assembly

BoldSign.Api.dll

The webhook document event object.

[DataContract]
public class DocumentEvent : IWebhookData

Inheritance

object

DocumentEvent

Implements

IWebhookData

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

BrandId

Gets or sets the selected brand.

[DataMember(Name = "brandId", EmitDefaultValue = false)]
[JsonProperty("brandId")]
public string BrandId { get; set; }

Property Value

string

CcDetails

Gets or sets the CC details.

[DataMember(Name = "ccDetails", EmitDefaultValue = false)]
[JsonProperty("ccDetails")]
public List<CcDetails> CcDetails { get; set; }

Property Value

List<CcDetails>

Gets or sets the CC details.

CreatedDate

Gets or sets the createdDate.

[DataMember(Name = "createdDate", EmitDefaultValue = false)]
[JsonProperty("createdDate")]
public long? CreatedDate { get; set; }

Property Value

long?

Gets or sets the createdDate.

DisableEmails

Gets or sets a value indicating whether enable embedded signing.

[DataMember(Name = "disableEmails", EmitDefaultValue = false)]
[JsonProperty("disableEmails")]
public bool? DisableEmails { get; set; }

Property Value

bool?

Gets or sets a value indicating whether enable embedded signing.

DocumentDescription

Gets or sets document description.

[DataMember(Name = "documentDescription", EmitDefaultValue = false)]
[JsonProperty("documentDescription")]
public string DocumentDescription { get; set; }

Property Value

string

Gets or sets document description.

DocumentDownloadOption

Gets or sets the document download option.

[DataMember(Name = "documentDownloadOption", EmitDefaultValue = true)]
[JsonProperty("documentDownloadOption")]
public DocumentDownloadOption? DocumentDownloadOption { get; set; }

Property Value

DocumentDownloadOption?

DocumentId

Gets or sets the document id.

[DataMember(Name = "documentId", EmitDefaultValue = false)]
[JsonProperty("documentId")]
public string DocumentId { get; set; }

Property Value

string

Gets or sets the document id.

EnableSigningOrder

Gets or sets a value indicating whether enable signing order.

[DataMember(Name = "enableSigningOrder", EmitDefaultValue = false)]
[JsonProperty("enableSigningOrder")]
public bool? EnableSigningOrder { get; set; }

Property Value

bool?

Gets or sets a value indicating whether enable signing order.

ErrorMessage

Gets or sets the error message.Available only when the send document is failed.

[DataMember(Name = "errorMessage", EmitDefaultValue = false)]
[JsonProperty("errorMessage")]
public string ErrorMessage { get; set; }

Property Value

string

Gets or sets the error message.Available only when the send document is failed.

ExpiryDate

Gets or sets the expiryDate.

[DataMember(Name = "expiryDate", EmitDefaultValue = false)]
[JsonProperty("expiryDate")]
public long? ExpiryDate { get; set; }

Property Value

long?

Gets or sets the expiryDate.

IsCombinedAudit

Gets or sets a value indicating whether audit trail is combined or not.

[DataMember(Name = "isCombinedAudit", EmitDefaultValue = false)]
[JsonProperty("isCombinedAudit")]
public bool? IsCombinedAudit { get; set; }

Property Value

bool?

Gets the value of indicating whether audit trail is combined or not.

Labels

Gets or sets the labels.

[DataMember(Name = "labels", EmitDefaultValue = false)]
[JsonProperty("labels")]
public List<string> Labels { get; set; }

Property Value

List<string>

MessageTitle

Gets or sets the messageTitle.

[DataMember(Name = "messageTitle", EmitDefaultValue = false)]
[JsonProperty("messageTitle")]
public string MessageTitle { get; set; }

Property Value

string

Gets or sets the messageTitle.

MetaData

Gets or sets the metadata.

[DataMember(Name = "metaData", EmitDefaultValue = false)]
[JsonProperty("metaData")]
public Dictionary<string, string> MetaData { get; set; }

Property Value

Dictionary<string, string>

ObjectType

Gets or sets the object name.

[JsonProperty("object")]
public string ObjectType { get; set; }

Property Value

string

OnBehalfOf

Gets or sets the on behalf of email.

[DataMember(Name = "onBehalfOf", EmitDefaultValue = false)]
[JsonProperty("onBehalfOf")]
public string OnBehalfOf { get; set; }

Property Value

string

RevokeMessage

<br>Gets or sets document revoked message by the sender. <br>Available only when the document is revoked.

[DataMember(Name = "revokeMessage", EmitDefaultValue = false)]
[JsonProperty("revokeMessage")]
public string RevokeMessage { get; set; }

Property Value

string

<br>Gets or sets document revoked message by the sender. <br>Available only when the document is revoked.

SenderDetail

Gets or Sets SenderDetail

[DataMember(Name = "senderDetail", EmitDefaultValue = false)]
[JsonProperty("senderDetail")]
public DocumentSenderDetails SenderDetail { get; set; }

Property Value

DocumentSenderDetails

SignerDetails

Gets or sets the signerDetails.

[DataMember(Name = "signerDetails", EmitDefaultValue = false)]
[JsonProperty("signerDetails")]
public List<SignerDetails> SignerDetails { get; set; }

Property Value

List<SignerDetails>

Gets or sets the signerDetails.

Status

Gets or Sets Status

[DataMember(Name = "status", EmitDefaultValue = false)]
[JsonProperty("status")]
public DocumentStatus Status { get; set; }

Property Value

DocumentStatus