com.docusign.esign.model

Class UserInformation

java.lang.Object

com.docusign.esign.model.UserInformation

public class UserInformation
extends Object

UserInformation

Constructor Summary

Constructors

Constructor and Description
UserInformation()

Method Summary

Methods

Modifier and Type	Method and Description
UserInformation	accountManagementGranular(UserAccountManagementGranularInformation accountManagementGranular)
UserInformation	activationAccessCode(String activationAccessCode)
UserInformation	addCustomSettingsItem(NameValue customSettingsItem)
UserInformation	addGroupListItem(Group groupListItem)
UserInformation	addUserSettingsItem(NameValue userSettingsItem)
UserInformation	createdDateTime(String createdDateTime)
UserInformation	customSettings(List<NameValue> customSettings)
UserInformation	email(String email)
UserInformation	enableConnectForUser(String enableConnectForUser)
boolean	equals(Object o)
UserInformation	errorDetails(ErrorDetails errorDetails)
UserInformation	firstName(String firstName)
UserInformation	forgottenPasswordInfo(ForgottenPasswordInformation forgottenPasswordInfo)
UserAccountManagementGranularInformation	getAccountManagementGranular() Get accountManagementGranular
String	getActivationAccessCode() The activation code the new user must enter when activating their account.
String	getCreatedDateTime() Indicates the date and time the item was created.
List<NameValue>	getCustomSettings() The name/value pair information for the user custom setting.
String	getEmail()
String	getEnableConnectForUser() Specifies whether the user is enabled for updates from DocuSign Connect.
ErrorDetails	getErrorDetails() Get errorDetails
String	getFirstName() The user's first name.
ForgottenPasswordInformation	getForgottenPasswordInfo() Get forgottenPasswordInfo
List<Group>	getGroupList() A list of the group information for groups to add the user to.
AddressInformationV2	getHomeAddress() Get homeAddress
String	getInitialsImageUri() Contains the URI for an endpoint that you can use to retrieve the initials image.
String	getIsAdmin() Determines if the feature set is actively set as part of the plan.
String	getJobTitle()
String	getLastLogin() Shows the date-time when the user last logged on to the system.
String	getLastName() The user's last name.
String	getLoginStatus() Shows the current status of the user's password.
String	getMiddleName() The user's middle name.
String	getPassword()
String	getPasswordExpiration()
String	getPermissionProfileId()
String	getPermissionProfileName()
String	getProfileImageUri()
String	getSendActivationEmail()
String	getSendActivationOnInvalidLogin() When set to **true**, specifies that an additional activation email is sent to the user if they fail a log on before activating their account.
String	getSignatureImageUri() Contains the URI for an endpoint that you can use to retrieve the signature image.
String	getSuffixName() The suffix for the user's name.
String	getTitle() The title of the user.
String	getUri()
String	getUserId()
String	getUserName()
String	getUserProfileLastModifiedDate()
List<NameValue>	getUserSettings() The name/value pair information for user settings.
String	getUserStatus()
String	getUserType()
AddressInformationV2	getWorkAddress() Get workAddress
UserInformation	groupList(List<Group> groupList)
int	hashCode()
UserInformation	homeAddress(AddressInformationV2 homeAddress)
UserInformation	initialsImageUri(String initialsImageUri)
UserInformation	isAdmin(String isAdmin)
UserInformation	jobTitle(String jobTitle)
UserInformation	lastLogin(String lastLogin)
UserInformation	lastName(String lastName)
UserInformation	loginStatus(String loginStatus)
UserInformation	middleName(String middleName)
UserInformation	password(String password)
UserInformation	passwordExpiration(String passwordExpiration)
UserInformation	permissionProfileId(String permissionProfileId)
UserInformation	permissionProfileName(String permissionProfileName)
UserInformation	profileImageUri(String profileImageUri)
UserInformation	sendActivationEmail(String sendActivationEmail)
UserInformation	sendActivationOnInvalidLogin(String sendActivationOnInvalidLogin)
void	setAccountManagementGranular(UserAccountManagementGranularInformation accountManagementGranular)
void	setActivationAccessCode(String activationAccessCode)
void	setCreatedDateTime(String createdDateTime)
void	setCustomSettings(List<NameValue> customSettings)
void	setEmail(String email)
void	setEnableConnectForUser(String enableConnectForUser)
void	setErrorDetails(ErrorDetails errorDetails)
void	setFirstName(String firstName)
void	setForgottenPasswordInfo(ForgottenPasswordInformation forgottenPasswordInfo)
void	setGroupList(List<Group> groupList)
void	setHomeAddress(AddressInformationV2 homeAddress)
void	setInitialsImageUri(String initialsImageUri)
void	setIsAdmin(String isAdmin)
void	setJobTitle(String jobTitle)
void	setLastLogin(String lastLogin)
void	setLastName(String lastName)
void	setLoginStatus(String loginStatus)
void	setMiddleName(String middleName)
void	setPassword(String password)
void	setPasswordExpiration(String passwordExpiration)
void	setPermissionProfileId(String permissionProfileId)
void	setPermissionProfileName(String permissionProfileName)
void	setProfileImageUri(String profileImageUri)
void	setSendActivationEmail(String sendActivationEmail)
void	setSendActivationOnInvalidLogin(String sendActivationOnInvalidLogin)
void	setSignatureImageUri(String signatureImageUri)
void	setSuffixName(String suffixName)
void	setTitle(String title)
void	setUri(String uri)
void	setUserId(String userId)
void	setUserName(String userName)
void	setUserProfileLastModifiedDate(String userProfileLastModifiedDate)
void	setUserSettings(List<NameValue> userSettings)
void	setUserStatus(String userStatus)
void	setUserType(String userType)
void	setWorkAddress(AddressInformationV2 workAddress)
UserInformation	signatureImageUri(String signatureImageUri)
UserInformation	suffixName(String suffixName)
UserInformation	title(String title)
String	toString()
UserInformation	uri(String uri)
UserInformation	userId(String userId)
UserInformation	userName(String userName)
UserInformation	userProfileLastModifiedDate(String userProfileLastModifiedDate)
UserInformation	userSettings(List<NameValue> userSettings)
UserInformation	userStatus(String userStatus)
UserInformation	userType(String userType)
UserInformation	workAddress(AddressInformationV2 workAddress)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UserInformation

public UserInformation()

Method Detail

accountManagementGranular

public UserInformation accountManagementGranular(UserAccountManagementGranularInformation accountManagementGranular)

getAccountManagementGranular

public UserAccountManagementGranularInformation getAccountManagementGranular()

Get accountManagementGranular

Returns:

accountManagementGranular

setAccountManagementGranular

public void setAccountManagementGranular(UserAccountManagementGranularInformation accountManagementGranular)

activationAccessCode

public UserInformation activationAccessCode(String activationAccessCode)

getActivationAccessCode

public String getActivationAccessCode()

The activation code the new user must enter when activating their account.

Returns:

activationAccessCode

setActivationAccessCode

public void setActivationAccessCode(String activationAccessCode)

createdDateTime

public UserInformation createdDateTime(String createdDateTime)

getCreatedDateTime

public String getCreatedDateTime()

Indicates the date and time the item was created.

Returns:

createdDateTime

setCreatedDateTime

public void setCreatedDateTime(String createdDateTime)

customSettings

public UserInformation customSettings(List<NameValue> customSettings)

addCustomSettingsItem

public UserInformation addCustomSettingsItem(NameValue customSettingsItem)

getCustomSettings

public List<NameValue> getCustomSettings()

The name/value pair information for the user custom setting.

Returns:

customSettings

setCustomSettings

public void setCustomSettings(List<NameValue> customSettings)

email

public UserInformation email(String email)

getEmail

public String getEmail()

Returns:

email

setEmail

public void setEmail(String email)

enableConnectForUser

public UserInformation enableConnectForUser(String enableConnectForUser)

getEnableConnectForUser

public String getEnableConnectForUser()

Specifies whether the user is enabled for updates from DocuSign Connect. Valid values: true or false.

Returns:

enableConnectForUser

setEnableConnectForUser

public void setEnableConnectForUser(String enableConnectForUser)

errorDetails

public UserInformation errorDetails(ErrorDetails errorDetails)

getErrorDetails

public ErrorDetails getErrorDetails()

Get errorDetails

Returns:

errorDetails

setErrorDetails

public void setErrorDetails(ErrorDetails errorDetails)

firstName

public UserInformation firstName(String firstName)

getFirstName

public String getFirstName()

The user's first name. Maximum Length: 50 characters.

Returns:

firstName

setFirstName

public void setFirstName(String firstName)

forgottenPasswordInfo

public UserInformation forgottenPasswordInfo(ForgottenPasswordInformation forgottenPasswordInfo)

getForgottenPasswordInfo

public ForgottenPasswordInformation getForgottenPasswordInfo()

Get forgottenPasswordInfo

Returns:

forgottenPasswordInfo

setForgottenPasswordInfo

public void setForgottenPasswordInfo(ForgottenPasswordInformation forgottenPasswordInfo)

groupList

public UserInformation groupList(List<Group> groupList)

addGroupListItem

public UserInformation addGroupListItem(Group groupListItem)

getGroupList

public List<Group> getGroupList()

A list of the group information for groups to add the user to. Group information can be found by calling [ML:GET group information]. The only required parameter is groupId. The parameters are: * groupId - The DocuSign group ID for the group. * groupName - The name of the group * permissionProfileId - The ID of the permission profile associated with the group. * groupType - The group type.

Returns:

groupList

setGroupList

public void setGroupList(List<Group> groupList)

homeAddress

public UserInformation homeAddress(AddressInformationV2 homeAddress)

getHomeAddress

public AddressInformationV2 getHomeAddress()

Get homeAddress

Returns:

homeAddress

setHomeAddress

public void setHomeAddress(AddressInformationV2 homeAddress)

initialsImageUri

public UserInformation initialsImageUri(String initialsImageUri)

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)

isAdmin

public UserInformation isAdmin(String isAdmin)

getIsAdmin

public String getIsAdmin()

Determines if the feature set is actively set as part of the plan.

Returns:

isAdmin

setIsAdmin

public void setIsAdmin(String isAdmin)

jobTitle

public UserInformation jobTitle(String jobTitle)

getJobTitle

public String getJobTitle()

Returns:

jobTitle

setJobTitle

public void setJobTitle(String jobTitle)

lastLogin

public UserInformation lastLogin(String lastLogin)

getLastLogin

public String getLastLogin()

Shows the date-time when the user last logged on to the system.

Returns:

lastLogin

setLastLogin

public void setLastLogin(String lastLogin)

lastName

public UserInformation lastName(String lastName)

getLastName

public String getLastName()

The user's last name. Maximum Length: 50 characters.

Returns:

lastName

setLastName

public void setLastName(String lastName)

loginStatus

public UserInformation loginStatus(String loginStatus)

getLoginStatus

public String getLoginStatus()

Shows the current status of the user's password. Possible values are: * password_reset * password_active * password_expired * password_locked * password_reset_failed

Returns:

loginStatus

setLoginStatus

public void setLoginStatus(String loginStatus)

middleName

public UserInformation middleName(String middleName)

getMiddleName

public String getMiddleName()

The user's middle name. Maximum Length: 50 characters.

Returns:

middleName

setMiddleName

public void setMiddleName(String middleName)

password

public UserInformation password(String password)

getPassword

public String getPassword()

Returns:

password

setPassword

public void setPassword(String password)

passwordExpiration

public UserInformation passwordExpiration(String passwordExpiration)

getPasswordExpiration

public String getPasswordExpiration()

Returns:

passwordExpiration

setPasswordExpiration

public void setPasswordExpiration(String passwordExpiration)

permissionProfileId

public UserInformation permissionProfileId(String permissionProfileId)

getPermissionProfileId

public String getPermissionProfileId()

Returns:

permissionProfileId

setPermissionProfileId

public void setPermissionProfileId(String permissionProfileId)

permissionProfileName

public UserInformation permissionProfileName(String permissionProfileName)

getPermissionProfileName

public String getPermissionProfileName()

Returns:

permissionProfileName

setPermissionProfileName

public void setPermissionProfileName(String permissionProfileName)

profileImageUri

public UserInformation profileImageUri(String profileImageUri)

getProfileImageUri

public String getProfileImageUri()

Returns:

profileImageUri

setProfileImageUri

public void setProfileImageUri(String profileImageUri)

sendActivationEmail

public UserInformation sendActivationEmail(String sendActivationEmail)

getSendActivationEmail

public String getSendActivationEmail()

Returns:

sendActivationEmail

setSendActivationEmail

public void setSendActivationEmail(String sendActivationEmail)

sendActivationOnInvalidLogin

public UserInformation sendActivationOnInvalidLogin(String sendActivationOnInvalidLogin)

getSendActivationOnInvalidLogin

public String getSendActivationOnInvalidLogin()

When set to **true**, specifies that an additional activation email is sent to the user if they fail a log on before activating their account.

Returns:

sendActivationOnInvalidLogin

setSendActivationOnInvalidLogin

public void setSendActivationOnInvalidLogin(String sendActivationOnInvalidLogin)

signatureImageUri

public UserInformation signatureImageUri(String signatureImageUri)

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)

suffixName

public UserInformation suffixName(String suffixName)

getSuffixName

public String getSuffixName()

The suffix for the user's name. Maximum Length: 50 characters.

Returns:

suffixName

setSuffixName

public void setSuffixName(String suffixName)

title

public UserInformation title(String title)

getTitle

public String getTitle()

The title of the user.

Returns:

title

setTitle

public void setTitle(String title)

uri

public UserInformation uri(String uri)

getUri

public String getUri()

Returns:

uri

setUri

public void setUri(String uri)

userId

public UserInformation userId(String userId)

getUserId

public String getUserId()

Returns:

userId

setUserId

public void setUserId(String userId)

userName

public UserInformation userName(String userName)

getUserName

public String getUserName()

Returns:

userName

setUserName

public void setUserName(String userName)

userProfileLastModifiedDate

public UserInformation userProfileLastModifiedDate(String userProfileLastModifiedDate)

getUserProfileLastModifiedDate

public String getUserProfileLastModifiedDate()

Returns:

userProfileLastModifiedDate

setUserProfileLastModifiedDate

public void setUserProfileLastModifiedDate(String userProfileLastModifiedDate)

userSettings

public UserInformation userSettings(List<NameValue> userSettings)

addUserSettingsItem

public UserInformation addUserSettingsItem(NameValue userSettingsItem)

getUserSettings

public List<NameValue> getUserSettings()

The name/value pair information for user settings. These determine the actions that a user can take in the account. The `[ML:userSettings]` are listed and described below.

Returns:

userSettings

setUserSettings

public void setUserSettings(List<NameValue> userSettings)

userStatus

public UserInformation userStatus(String userStatus)

getUserStatus

public String getUserStatus()

Returns:

userStatus

setUserStatus

public void setUserStatus(String userStatus)

userType

public UserInformation userType(String userType)

getUserType

public String getUserType()

Returns:

userType

setUserType

public void setUserType(String userType)

workAddress

public UserInformation workAddress(AddressInformationV2 workAddress)

getWorkAddress

public AddressInformationV2 getWorkAddress()

Get workAddress

Returns:

workAddress

setWorkAddress

public void setWorkAddress(AddressInformationV2 workAddress)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object