Package com.docusign.esign.model
Class AccountSignature
- java.lang.Object
-
- com.docusign.esign.model.AccountSignature
-
public class AccountSignature extends Object
AccountSignature.
-
-
Constructor Summary
Constructors Constructor Description AccountSignature()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AccountSignatureaddSignatureGroupsItem(SignatureGroup signatureGroupsItem)addSignatureGroupsItem.AccountSignatureaddSignatureUsersItem(SignatureUser signatureUsersItem)addSignatureUsersItem.AccountSignatureadoptedDateTime(String adoptedDateTime)adoptedDateTime.AccountSignaturecreatedDateTime(String createdDateTime)createdDateTime.AccountSignaturecustomField(String customField)customField.AccountSignaturedateStampProperties(DateStampProperties dateStampProperties)dateStampProperties.AccountSignaturedisallowUserResizeStamp(String disallowUserResizeStamp)disallowUserResizeStamp.booleanequals(Object o)Compares objects.AccountSignatureerrorDetails(ErrorDetails errorDetails)errorDetails.AccountSignatureexternalID(String externalID)externalID.StringgetAdoptedDateTime().StringgetCreatedDateTime()Indicates the date and time the item was created..StringgetCustomField().DateStampPropertiesgetDateStampProperties()Specifies the area in which a date stamp is placed.StringgetDisallowUserResizeStamp().ErrorDetailsgetErrorDetails()This object describes errors that occur.StringgetExternalID().StringgetImageBase64().StringgetImageType().StringgetInitials150ImageId().StringgetInitialsImageUri()Contains the URI for an endpoint that you can use to retrieve the initials image..StringgetIsDefault().StringgetLastModifiedDateTime()The date and time the item was last modified..StringgetNrdsId().StringgetNrdsLastName().StringgetNrdsStatus().StringgetPhoneticName().StringgetSignature150ImageId().StringgetSignatureFont().List<SignatureGroup>getSignatureGroups().StringgetSignatureId()Specifies the signature ID associated with the signature name.StringgetSignatureImageUri()Contains the URI for an endpoint that you can use to retrieve the signature image..StringgetSignatureInitials().StringgetSignatureName()Specifies the user signature name..StringgetSignatureRights().StringgetSignatureType().List<SignatureUser>getSignatureUsers().StringgetStampFormat().StringgetStampImageUri().StringgetStampSizeMM().StringgetStampType().StringgetStatus()Indicates the envelope status.inthashCode()Returns the HashCode.AccountSignatureimageBase64(String imageBase64)imageBase64.AccountSignatureimageType(String imageType)imageType.AccountSignatureinitials150ImageId(String initials150ImageId)initials150ImageId.AccountSignatureinitialsImageUri(String initialsImageUri)initialsImageUri.AccountSignatureisDefault(String isDefault)isDefault.AccountSignaturelastModifiedDateTime(String lastModifiedDateTime)lastModifiedDateTime.AccountSignaturenrdsId(String nrdsId)nrdsId.AccountSignaturenrdsLastName(String nrdsLastName)nrdsLastName.AccountSignaturenrdsStatus(String nrdsStatus)nrdsStatus.AccountSignaturephoneticName(String phoneticName)phoneticName.voidsetAdoptedDateTime(String adoptedDateTime)setAdoptedDateTime.voidsetCreatedDateTime(String createdDateTime)setCreatedDateTime.voidsetCustomField(String customField)setCustomField.voidsetDateStampProperties(DateStampProperties dateStampProperties)setDateStampProperties.voidsetDisallowUserResizeStamp(String disallowUserResizeStamp)setDisallowUserResizeStamp.voidsetErrorDetails(ErrorDetails errorDetails)setErrorDetails.voidsetExternalID(String externalID)setExternalID.voidsetImageBase64(String imageBase64)setImageBase64.voidsetImageType(String imageType)setImageType.voidsetInitials150ImageId(String initials150ImageId)setInitials150ImageId.voidsetInitialsImageUri(String initialsImageUri)setInitialsImageUri.voidsetIsDefault(String isDefault)setIsDefault.voidsetLastModifiedDateTime(String lastModifiedDateTime)setLastModifiedDateTime.voidsetNrdsId(String nrdsId)setNrdsId.voidsetNrdsLastName(String nrdsLastName)setNrdsLastName.voidsetNrdsStatus(String nrdsStatus)setNrdsStatus.voidsetPhoneticName(String phoneticName)setPhoneticName.voidsetSignature150ImageId(String signature150ImageId)setSignature150ImageId.voidsetSignatureFont(String signatureFont)setSignatureFont.voidsetSignatureGroups(List<SignatureGroup> signatureGroups)setSignatureGroups.voidsetSignatureId(String signatureId)setSignatureId.voidsetSignatureImageUri(String signatureImageUri)setSignatureImageUri.voidsetSignatureInitials(String signatureInitials)setSignatureInitials.voidsetSignatureName(String signatureName)setSignatureName.voidsetSignatureRights(String signatureRights)setSignatureRights.voidsetSignatureType(String signatureType)setSignatureType.voidsetSignatureUsers(List<SignatureUser> signatureUsers)setSignatureUsers.voidsetStampFormat(String stampFormat)setStampFormat.voidsetStampImageUri(String stampImageUri)setStampImageUri.voidsetStampSizeMM(String stampSizeMM)setStampSizeMM.voidsetStampType(String stampType)setStampType.voidsetStatus(String status)setStatus.AccountSignaturesignature150ImageId(String signature150ImageId)signature150ImageId.AccountSignaturesignatureFont(String signatureFont)signatureFont.AccountSignaturesignatureGroups(List<SignatureGroup> signatureGroups)signatureGroups.AccountSignaturesignatureId(String signatureId)signatureId.AccountSignaturesignatureImageUri(String signatureImageUri)signatureImageUri.AccountSignaturesignatureInitials(String signatureInitials)signatureInitials.AccountSignaturesignatureName(String signatureName)signatureName.AccountSignaturesignatureRights(String signatureRights)signatureRights.AccountSignaturesignatureType(String signatureType)signatureType.AccountSignaturesignatureUsers(List<SignatureUser> signatureUsers)signatureUsers.AccountSignaturestampFormat(String stampFormat)stampFormat.AccountSignaturestampImageUri(String stampImageUri)stampImageUri.AccountSignaturestampSizeMM(String stampSizeMM)stampSizeMM.AccountSignaturestampType(String stampType)stampType.AccountSignaturestatus(String status)status.StringtoString()Converts the given object to string.
-
-
-
Method Detail
-
adoptedDateTime
public AccountSignature adoptedDateTime(String adoptedDateTime)
adoptedDateTime.- Returns:
- AccountSignature
-
getAdoptedDateTime
public String getAdoptedDateTime()
.- Returns:
- adoptedDateTime
-
setAdoptedDateTime
public void setAdoptedDateTime(String adoptedDateTime)
setAdoptedDateTime.
-
createdDateTime
public AccountSignature createdDateTime(String createdDateTime)
createdDateTime.- Returns:
- AccountSignature
-
getCreatedDateTime
public String getCreatedDateTime()
Indicates the date and time the item was created..- Returns:
- createdDateTime
-
setCreatedDateTime
public void setCreatedDateTime(String createdDateTime)
setCreatedDateTime.
-
customField
public AccountSignature customField(String customField)
customField.- Returns:
- AccountSignature
-
getCustomField
public String getCustomField()
.- Returns:
- customField
-
setCustomField
public void setCustomField(String customField)
setCustomField.
-
dateStampProperties
public AccountSignature dateStampProperties(DateStampProperties dateStampProperties)
dateStampProperties.- Returns:
- AccountSignature
-
getDateStampProperties
public DateStampProperties getDateStampProperties()
Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area. This property contains the following information about the central rectangle: - `DateAreaX`: The X axis position of the top-left corner. - `DateAreaY`: The Y axis position of the top-left corner. - `DateAreaWidth`: The width of the rectangle. - `DateAreaHeight`: The height of the rectangle..- Returns:
- dateStampProperties
-
setDateStampProperties
public void setDateStampProperties(DateStampProperties dateStampProperties)
setDateStampProperties.
-
disallowUserResizeStamp
public AccountSignature disallowUserResizeStamp(String disallowUserResizeStamp)
disallowUserResizeStamp.- Returns:
- AccountSignature
-
getDisallowUserResizeStamp
public String getDisallowUserResizeStamp()
.- Returns:
- disallowUserResizeStamp
-
setDisallowUserResizeStamp
public void setDisallowUserResizeStamp(String disallowUserResizeStamp)
setDisallowUserResizeStamp.
-
errorDetails
public AccountSignature errorDetails(ErrorDetails errorDetails)
errorDetails.- Returns:
- AccountSignature
-
getErrorDetails
public ErrorDetails getErrorDetails()
This object describes errors that occur. It is only valid for responses and ignored in requests..- Returns:
- errorDetails
-
setErrorDetails
public void setErrorDetails(ErrorDetails errorDetails)
setErrorDetails.
-
externalID
public AccountSignature externalID(String externalID)
externalID.- Returns:
- AccountSignature
-
getExternalID
public String getExternalID()
.- Returns:
- externalID
-
setExternalID
public void setExternalID(String externalID)
setExternalID.
-
imageBase64
public AccountSignature imageBase64(String imageBase64)
imageBase64.- Returns:
- AccountSignature
-
getImageBase64
public String getImageBase64()
.- Returns:
- imageBase64
-
setImageBase64
public void setImageBase64(String imageBase64)
setImageBase64.
-
imageType
public AccountSignature imageType(String imageType)
imageType.- Returns:
- AccountSignature
-
getImageType
public String getImageType()
.- Returns:
- imageType
-
setImageType
public void setImageType(String imageType)
setImageType.
-
initials150ImageId
public AccountSignature initials150ImageId(String initials150ImageId)
initials150ImageId.- Returns:
- AccountSignature
-
getInitials150ImageId
public String getInitials150ImageId()
.- Returns:
- initials150ImageId
-
setInitials150ImageId
public void setInitials150ImageId(String initials150ImageId)
setInitials150ImageId.
-
initialsImageUri
public AccountSignature initialsImageUri(String initialsImageUri)
initialsImageUri.- Returns:
- AccountSignature
-
getInitialsImageUri
public String getInitialsImageUri()
Contains the URI for an endpoint that you can use to retrieve the initials image..- Returns:
- initialsImageUri
-
setInitialsImageUri
public void setInitialsImageUri(String initialsImageUri)
setInitialsImageUri.
-
isDefault
public AccountSignature isDefault(String isDefault)
isDefault.- Returns:
- AccountSignature
-
getIsDefault
public String getIsDefault()
.- Returns:
- isDefault
-
setIsDefault
public void setIsDefault(String isDefault)
setIsDefault.
-
lastModifiedDateTime
public AccountSignature lastModifiedDateTime(String lastModifiedDateTime)
lastModifiedDateTime.- Returns:
- AccountSignature
-
getLastModifiedDateTime
public String getLastModifiedDateTime()
The date and time the item was last modified..- Returns:
- lastModifiedDateTime
-
setLastModifiedDateTime
public void setLastModifiedDateTime(String lastModifiedDateTime)
setLastModifiedDateTime.
-
nrdsId
public AccountSignature nrdsId(String nrdsId)
nrdsId.- Returns:
- AccountSignature
-
getNrdsId
public String getNrdsId()
.- Returns:
- nrdsId
-
setNrdsId
public void setNrdsId(String nrdsId)
setNrdsId.
-
nrdsLastName
public AccountSignature nrdsLastName(String nrdsLastName)
nrdsLastName.- Returns:
- AccountSignature
-
getNrdsLastName
public String getNrdsLastName()
.- Returns:
- nrdsLastName
-
setNrdsLastName
public void setNrdsLastName(String nrdsLastName)
setNrdsLastName.
-
nrdsStatus
public AccountSignature nrdsStatus(String nrdsStatus)
nrdsStatus.- Returns:
- AccountSignature
-
getNrdsStatus
public String getNrdsStatus()
.- Returns:
- nrdsStatus
-
setNrdsStatus
public void setNrdsStatus(String nrdsStatus)
setNrdsStatus.
-
phoneticName
public AccountSignature phoneticName(String phoneticName)
phoneticName.- Returns:
- AccountSignature
-
getPhoneticName
public String getPhoneticName()
.- Returns:
- phoneticName
-
setPhoneticName
public void setPhoneticName(String phoneticName)
setPhoneticName.
-
signature150ImageId
public AccountSignature signature150ImageId(String signature150ImageId)
signature150ImageId.- Returns:
- AccountSignature
-
getSignature150ImageId
public String getSignature150ImageId()
.- Returns:
- signature150ImageId
-
setSignature150ImageId
public void setSignature150ImageId(String signature150ImageId)
setSignature150ImageId.
-
signatureFont
public AccountSignature signatureFont(String signatureFont)
signatureFont.- Returns:
- AccountSignature
-
getSignatureFont
public String getSignatureFont()
.- Returns:
- signatureFont
-
setSignatureFont
public void setSignatureFont(String signatureFont)
setSignatureFont.
-
signatureGroups
public AccountSignature signatureGroups(List<SignatureGroup> signatureGroups)
signatureGroups.- Returns:
- AccountSignature
-
addSignatureGroupsItem
public AccountSignature addSignatureGroupsItem(SignatureGroup signatureGroupsItem)
addSignatureGroupsItem.- Returns:
- AccountSignature
-
getSignatureGroups
public List<SignatureGroup> getSignatureGroups()
.- Returns:
- signatureGroups
-
setSignatureGroups
public void setSignatureGroups(List<SignatureGroup> signatureGroups)
setSignatureGroups.
-
signatureId
public AccountSignature signatureId(String signatureId)
signatureId.- Returns:
- AccountSignature
-
getSignatureId
public String getSignatureId()
Specifies the signature ID associated with the signature name. You can use the signature ID in the URI in place of the signature name, and the value stored in the `signatureName` property in the body is used. This allows the use of special characters (such as \"&\", \"<\", \">\") in a the signature name. Note that with each update to signatures, the returned signature ID might change, so the caller will need to trigger off the signature name to get the new signature ID..- Returns:
- signatureId
-
setSignatureId
public void setSignatureId(String signatureId)
setSignatureId.
-
signatureImageUri
public AccountSignature signatureImageUri(String signatureImageUri)
signatureImageUri.- Returns:
- AccountSignature
-
getSignatureImageUri
public String getSignatureImageUri()
Contains the URI for an endpoint that you can use to retrieve the signature image..- Returns:
- signatureImageUri
-
setSignatureImageUri
public void setSignatureImageUri(String signatureImageUri)
setSignatureImageUri.
-
signatureInitials
public AccountSignature signatureInitials(String signatureInitials)
signatureInitials.- Returns:
- AccountSignature
-
getSignatureInitials
public String getSignatureInitials()
.- Returns:
- signatureInitials
-
setSignatureInitials
public void setSignatureInitials(String signatureInitials)
setSignatureInitials.
-
signatureName
public AccountSignature signatureName(String signatureName)
signatureName.- Returns:
- AccountSignature
-
getSignatureName
public String getSignatureName()
Specifies the user signature name..- Returns:
- signatureName
-
setSignatureName
public void setSignatureName(String signatureName)
setSignatureName.
-
signatureRights
public AccountSignature signatureRights(String signatureRights)
signatureRights.- Returns:
- AccountSignature
-
getSignatureRights
public String getSignatureRights()
.- Returns:
- signatureRights
-
setSignatureRights
public void setSignatureRights(String signatureRights)
setSignatureRights.
-
signatureType
public AccountSignature signatureType(String signatureType)
signatureType.- Returns:
- AccountSignature
-
getSignatureType
public String getSignatureType()
.- Returns:
- signatureType
-
setSignatureType
public void setSignatureType(String signatureType)
setSignatureType.
-
signatureUsers
public AccountSignature signatureUsers(List<SignatureUser> signatureUsers)
signatureUsers.- Returns:
- AccountSignature
-
addSignatureUsersItem
public AccountSignature addSignatureUsersItem(SignatureUser signatureUsersItem)
addSignatureUsersItem.- Returns:
- AccountSignature
-
getSignatureUsers
public List<SignatureUser> getSignatureUsers()
.- Returns:
- signatureUsers
-
setSignatureUsers
public void setSignatureUsers(List<SignatureUser> signatureUsers)
setSignatureUsers.
-
stampFormat
public AccountSignature stampFormat(String stampFormat)
stampFormat.- Returns:
- AccountSignature
-
getStampFormat
public String getStampFormat()
.- Returns:
- stampFormat
-
setStampFormat
public void setStampFormat(String stampFormat)
setStampFormat.
-
stampImageUri
public AccountSignature stampImageUri(String stampImageUri)
stampImageUri.- Returns:
- AccountSignature
-
getStampImageUri
public String getStampImageUri()
.- Returns:
- stampImageUri
-
setStampImageUri
public void setStampImageUri(String stampImageUri)
setStampImageUri.
-
stampSizeMM
public AccountSignature stampSizeMM(String stampSizeMM)
stampSizeMM.- Returns:
- AccountSignature
-
getStampSizeMM
public String getStampSizeMM()
.- Returns:
- stampSizeMM
-
setStampSizeMM
public void setStampSizeMM(String stampSizeMM)
setStampSizeMM.
-
stampType
public AccountSignature stampType(String stampType)
stampType.- Returns:
- AccountSignature
-
getStampType
public String getStampType()
.- Returns:
- stampType
-
setStampType
public void setStampType(String stampType)
setStampType.
-
status
public AccountSignature status(String status)
status.- Returns:
- AccountSignature
-
getStatus
public String getStatus()
Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later..- Returns:
- status
-
setStatus
public void setStatus(String status)
setStatus.
-
equals
public boolean equals(Object o)
Compares objects.
-
-