Namespace BoldSign.Model
Classes
AccessCodeDetails
The access code model.
AddAuthenticationAccessCodeDetails
The access code model.
AuditEnvironment
AuditEnvironment
AuditTrail
AuditTrail collects the log of all actions that has happened on a document. The properties include action, ipaddress, name and so on.
AuditTrailRecipients
AuditTrailRecipients are users who requested audit trail for a document and the properties can be such as recipient email, name.
BehalfDocument
The behalf documents properties include users who acted on it, activity date, cc details, created date, and so on.
BehalfDocumentRecords
The behalf page records view model.
BehalfOf
The document's behalf sender detail includes name and email id.
BillingViewModel
The BillingViewModel includes action such as getting the Api credit details and so on.
BrandCustomFieldDetails
The custom form field details.
BrandDetails
The branding details model.
BrandingData
The branding result model.
BrandingRecords
The branding List model.
BrandSettings
Brand Settings.
ConditionalRule
The conditional rule properties include, field id and isChecked.
ContactDetails
The current page templates view model.
ContactPageDetails
The page details properties include page size, total number pages, and so on.
ContactsDetails
The current page templates view model.
ContactsList
The current page records view model.
CreateTeam
create team.
CreateUserRequest
The create user details.
CreateUserResponse
The create user details.
CreateUsers
The create user details.
CustomFieldCollection
The custom field collection.
CustomFieldMessage
The custom field message view model.
CustomFormField
The document form fields properties include, font, font color, font size and so on.
DateSignedField
TextBoxField
Document
The documents properties include users who acted on it, activity date, cc details, created date, and so on.
DocumentCC
The CC Details has the property email address.
DocumentCcDetails
The document cc details properties are email address, user Id.
DocumentCreated
Document Created Action Result.
DocumentFileBytes
The document file bytes.
DocumentFilePath
The document file path.
DocumentFiles
The document files properties include document name, page count.
DocumentFileStream
The document file stream result.
DocumentFormFields
The document form fields properties include, font, font color, font size and so on.
DocumentInfo
The document information include the language, document title and document description.
DocumentProperties
The document properties includes any activity taken on the document, the user who acts on it, date of action, description of document, and so on.
DocumentReassign
Document signer reassign details.
DocumentRecords
The current page records view model.
DocumentSenderDetail
The document sender detail includes Email ID, name and so on.
DocumentSigner
The signer properties include the authentication code for the singer, email address, name, role, and so on.
DocumentSignerDetails
The document signer details have properties that shows if the document delivery failed, reassigned, viewed, and so on.
DocumentSignerProperties
The document signer properties include authentication, order of signers, signer status, and so on.
DocumentTags
The Add and Delete tag model.
DropdownField
DropdownField.
EditableDateFieldSettings
EditableDateFieldSettings.
EmbeddedCustomFieldCreated
The Embedded Custom Field Url.
EmbeddedCustomFieldDetails
Embedded custom field details.
EmbeddedDocumentRequest
Embedded send request DTO.
EmbeddedSendCreated
Embedded send document created result.
EmbeddedSigningLink
Contains Embedded Signing Link for a document signer.
EmbeddedTemplateRequest
Embedded send request using template DTO.
ErrorResult
Error Action Result used when the request is not successful.
ExistingFormField
Existing Form Fields details.
FormField
The form field properties include character limit, font, font size, and so on.
ImageFileBytes
The image file bytes.
ImageFilePath
The image file path.
ImageFileStream
The image file stream.
ImageInfo
ImageInfo.
InlineObject
InlineObject
NotificationSettings
The sender identity view model.
PageDetails
The page details properties include page size, total number pages, and so on.
PhoneNumber
The phone number include the number and country code.
ProblemDetails
ProblemDetails
RadioButtonField
RecipientNotificationSettings
The Recipient Notification Settings.
Rectangle
The rectangle properties are height, width, and so on.
ReminderMessage
Reminder Message for signers.
ReminderSettings
The reminder settings have properties include enabling auto reminder, reminder recurring count, and so on.
RevokeDocument
The turn down document action DTO such as Revoke or Decline the document.
Roles
Return roles details for a particular document or template.
SenderIdentityCreated
Sender identity created action result.
SenderIdentityList
The sender identity list view model.
SenderIdentityRequest
The sender identity request.
SenderIdentityViewModel
The sender identity view model.
SendForSign
Send for Sign request DTO.
SendForSignFromTemplate
Return send for signature template details in which the document is in the form of.
SharedTemplateDetail
The shared template details have functions that define the team id, access type of shared template.
Size
The rectangle properties are height, width, and so on.
TeamCreated
Team and team user details.
TeamDetails
Team and team user details.
TeamDocumentRecords
The current page records view model.
TeamList
Team list.
TeamPageDetails
The page details properties include page size, total number pages, and so on.
Teams
Team and team user details.
Template
Template Document DTO.
TemplateCC
Template document cc user details.
TemplateProperties
The template properties includes any activity taken on the template, the user who acts on it, date of action, description of template, and so on.
TemplateRecords
The current page templates view model.
TemplateSenderDetail
The template sender user details have functions that define the email address, name of user ID of the recipient.
TemplateSenderDetails
The template document sender user details have functions that define the email address, name of user ID of the recipient.
TemplateSignerDetails
The template signer details have functions to perform actions like enabling access code for the signer, setting up the host’s email, name and user ID, defining the value for the order of the signers, and so on.
TextBoxField
TextBoxField
UpdateTeam
create team.
UpdateUser
The update user details.
UserPageDetails
The page details properties include page size, total number pages, and so on.
UserProperties
The current page user view model.
UserRecords
The current page records view model.
UsersDetails
The current page templates view model.
ViewBrandDetails
The branding details model.
ViewCustomFieldDetails
The custom field details.
Interfaces
IDocumentFile
IEmbeddedRequest
The embedded send interface.
IFormField
IImageFile
Image File.
Enums
ActivityAction
Defines ActivityAction.
AuditAction
Defines AuditAction to be recorded in audit trail.
AuthenticationType
AuthenticationType.
ContactType
Defines DocumentList as Sent, Received and Both.
DeliveryMode
Signature request delivery mode.
DocumentStatus
Defines DocumentStatus as completed, declined, draft, expired, in progress or revoked.
EmailSignedDocument
Represents email signed document.
ExpiryDateType
Expiry Date Type.
FieldType
Represents FieldType in the document.
FontFamily
Represents FontFamily.
Languages
Multiple Language enum.
Locales
The Locales.
PageType
Represents user’s different behalf page type.
PageViewOption
View option.
ReminderType
Defines ReminderType that can be set as per need.
SignerStatus
Defines SignerStatus.
SignerType
Represents SignerType. The default type is Signer but there is another type, Reviewer. A signer will have to sign on a document received. If the SignerType is reviewer then they don’t have to sign but only can view the document.
Status
Represents user’s different document status.
TemplateAccessType
Defines TemplateAccessType
TemplateType
Represents user’s different template type.
TransmitType
Defines DocumentList as Sent, Received and Both.
UserRole
Defines UserRoleType as Admin, TeamAdmin and TeamMember.
UserRoleType
Defines UserRoleType as Admin, TeamAdmin and Member.
UserStatus
Defines UserStatus as Active, InvitationPending, Deactivated.
UserStatusOption
Defines UserStatusOption as Activate Or Deactivate.
ValidationType
Defines ValidationType