Class CreateTemplateRequest

Namespace

BoldSign.Api.Model

Assembly

BoldSign.Api.dll

create template request DTO.

[DataContract(Name = "CreateTemplateRequest")]
public class CreateTemplateRequest : ITextTags, IDocumentUpload

Inheritance

object

CreateTemplateRequest

Implements

ITextTags

IDocumentUpload

Derived

CreateEmbeddedTemplateRequest

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

AllowMessageEditing

Gets or sets a value indicating whether the allow message editing option is enabled or disabled.

[JsonProperty("allowMessageEditing")]
public bool AllowMessageEditing { get; set; }

Property Value

bool

AllowModifyFiles

Gets or sets a value indicating whether to allow senders to replace or delete files.

[JsonProperty("allowModifyFiles")]
public bool AllowModifyFiles { get; set; }

Property Value

bool

AllowNewFiles

Gets or sets list of allow new files.

[JsonProperty("allowNewFiles")]
public bool AllowNewFiles { get; set; }

Property Value

bool

AllowNewRoles

Gets or sets a value indicating whether the allow message allow new role option is enabled or disabled.

[JsonProperty("allowNewRoles")]
public bool AllowNewRoles { get; set; }

Property Value

bool

AutoDetectFields

Gets or sets a value indicating whether to AutoDetect Fields for the document signer.

[JsonProperty("autoDetectFields")]
public bool AutoDetectFields { get; set; }

Property Value

bool

BrandId

Gets or sets the brandId.

[JsonProperty("brandId")]
public string BrandId { get; set; }

Property Value

string

CC

Gets or sets Template CC.

[JsonProperty("cc")]
public IEnumerable<DocumentCC> CC { get; set; }

Property Value

IEnumerable<DocumentCC>

Description

Gets or sets template description.

[JsonProperty("description")]
public string Description { get; set; }

Property Value

string

DocumentInfo

Gets or sets a documentInfo.

[JsonProperty("documentInfo")]
public IEnumerable<DocumentInfo> DocumentInfo { get; set; }

Property Value

IEnumerable<DocumentInfo>

DocumentMessage

Gets or sets document message or description.

[JsonProperty("documentMessage")]
public string DocumentMessage { get; set; }

Property Value

string

DocumentTitle

Gets or sets document title.

[JsonProperty("documentTitle")]
public string DocumentTitle { get; set; }

Property Value

string

EnablePrintAndSign

Gets or sets a value indicating whether the enable print and sign value option is enabled or disabled.

[JsonProperty("enablePrintAndSign")]
public bool EnablePrintAndSign { get; set; }

Property Value

bool

EnableReassign

Gets or sets a value indicating whether the enable reassign value option is enabled or disabled.

[JsonProperty("enableReassign")]
public bool EnableReassign { get; set; }

Property Value

bool

EnableSigningOrder

Gets or sets a value indicating whether the enable signing order value option is enabled or disabled.

public bool EnableSigningOrder { get; set; }

Property Value

bool

FileUrls

Gets or sets the FileUrl.

[JsonProperty("fileUrls")]
public List<Uri> FileUrls { get; set; }

Property Value

List<Uri>

Files

Gets or sets list of files.

[Required]
[JsonProperty("files")]
public List<IDocumentFile> Files { get; set; }

Property Value

List<IDocumentFile>

Labels

Gets or sets the document labels.

[JsonProperty("labels")]
public IEnumerable<string> Labels { get; set; }

Property Value

IEnumerable<string>

OnBehalfOf

Gets or sets the on behalf of email.

[JsonProperty("onBehalfOf")]
public string OnBehalfOf { get; set; }

Property Value

string

RecipientNotificationSettings

Gets or sets the Recipient Notification Settings.

[JsonProperty("recipientNotificationSettings")]
[Display(Description = "Recipient Notification Settings of the Template.")]
public RecipientNotificationSettings RecipientNotificationSettings { get; set; }

Property Value

RecipientNotificationSettings

Roles

Gets or sets the Roles details.

[Required]
public IEnumerable<TemplateRole> Roles { get; set; }

Property Value

IEnumerable<TemplateRole>

TemplateLabels

Gets or sets the template labels.

[JsonProperty("templateLabels")]
public IEnumerable<string> TemplateLabels { get; set; }

Property Value

IEnumerable<string>

TextTagDefinitions

Gets or sets the text tags definitions declared in the list can be used in the document by using the definition ID.

[JsonProperty("textTagDefinitions")]
public List<TextTagDefinition> TextTagDefinitions { get; set; }

Property Value

List<TextTagDefinition>

Title

Gets or sets title for the Template request.

[JsonProperty("title")]
public string Title { get; set; }

Property Value

string

UseTextTags

Gets or sets a value indicating whether to convert the text tags to form fields.

[JsonProperty("useTextTags")]
public bool UseTextTags { get; set; }

Property Value

bool