Documentation

UserInformation
in package

DocuSign

eSign

implements ModelInterface, ArrayAccess

UserInformation Class Doc Comment

Interfaces, Classes, Traits and Enums

ModelInterface: Interface abstracting model access.
ArrayAccess

DISCRIMINATOR = null
$attributeMap : array<string|int, string>: Array of attributes where the key is the local name, and the value is the original name
$container : array<string|int, mixed>: Associative array for storing property values
$getters : array<string|int, string>: Array of attributes to getter functions (for serialization of requests)
$setters : array<string|int, string>: Array of attributes to setter functions (for deserialization of responses)
$swaggerFormats : array<string|int, string>: Array of property to format mappings. Used for (de)serialization
$swaggerModelName : string: The original name of the model.
$swaggerTypes : array<string|int, string>: Array of property to type mappings. Used for (de)serialization
__construct() : mixed: Constructor
__toString() : string: Gets the string presentation of the object
attributeMap() : array<string|int, mixed>: Array of attributes where the key is the local name, and the value is the original name
getActivationAccessCode() : string|null: Gets activation_access_code
getCompany() : string|null: Gets company
getConnectConfigurations() : array<string|int, ConnectUserObject>: Gets connect_configurations
getCountryCode() : string|null: Gets country_code
getCreatedDateTime() : string|null: Gets created_date_time
getCustomSettings() : array<string|int, NameValue>: Gets custom_settings
getDefaultAccountId() : string|null: Gets default_account_id
getEmail() : string|null: Gets email
getEnableConnectForUser() : string|null: Gets enable_connect_for_user
getErrorDetails() : ErrorDetails: Gets error_details
getFirstName() : string|null: Gets first_name
getForgottenPasswordInfo() : ForgottenPasswordInformation: Gets forgotten_password_info
getGroupList() : array<string|int, Group>: Gets group_list
getHasRemoteNotary() : bool|null: Gets has_remote_notary
getHomeAddress() : AddressInformation: Gets home_address
getInitialsImageUri() : string|null: Gets initials_image_uri
getIsAdmin() : string|null: Gets is_admin
getIsAlternateAdmin() : string|null: Gets is_alternate_admin
getIsNarEnabled() : string|null: Gets is_nar_enabled
getJobTitle() : string|null: Gets job_title
getLastLogin() : string|null: Gets last_login
getLastName() : string|null: Gets last_name
getLoginStatus() : string|null: Gets login_status
getMiddleName() : string|null: Gets middle_name
getModelName() : string: The original name of the model.
getPassword() : string|null: Gets password
getPasswordExpiration() : string|null: Gets password_expiration
getPermissionProfileId() : string|null: Gets permission_profile_id
getPermissionProfileName() : string|null: Gets permission_profile_name
getProfileImageUri() : string|null: Gets profile_image_uri
getSendActivationEmail() : string|null: Gets send_activation_email
getSendActivationOnInvalidLogin() : string|null: Gets send_activation_on_invalid_login
getSignatureImageUri() : string|null: Gets signature_image_uri
getSubscribe() : string|null: Gets subscribe
getSuffixName() : string|null: Gets suffix_name
getters() : array<string|int, mixed>: Array of attributes to getter functions (for serialization of requests)
getTitle() : string|null: Gets title
getUri() : string|null: Gets uri
getUserAddedToAccountDateTime() : string|null: Gets user_added_to_account_date_time
getUserId() : string|null: Gets user_id
getUserName() : string|null: Gets user_name
getUserProfileLastModifiedDate() : string|null: Gets user_profile_last_modified_date
getUserSettings() : UserSettingsInformation: Gets user_settings
getUserStatus() : string|null: Gets user_status
getUserType() : string|null: Gets user_type
getWorkAddress() : AddressInformation: Gets work_address
listInvalidProperties() : array<string|int, mixed>: Show all the invalid properties with reasons.
offsetExists() : bool: Returns true if offset exists. False otherwise.
offsetGet() : mixed: Gets offset.
offsetSet() : void: Sets value based on offset.
offsetUnset() : void: Unsets offset.
setActivationAccessCode() : $this: Sets activation_access_code
setCompany() : $this: Sets company
setConnectConfigurations() : $this: Sets connect_configurations
setCountryCode() : $this: Sets country_code
setCreatedDateTime() : $this: Sets created_date_time
setCustomSettings() : $this: Sets custom_settings
setDefaultAccountId() : $this: Sets default_account_id
setEmail() : $this: Sets email
setEnableConnectForUser() : $this: Sets enable_connect_for_user
setErrorDetails() : $this: Sets error_details
setFirstName() : $this: Sets first_name
setForgottenPasswordInfo() : $this: Sets forgotten_password_info
setGroupList() : $this: Sets group_list
setHasRemoteNotary() : $this: Sets has_remote_notary
setHomeAddress() : $this: Sets home_address
setInitialsImageUri() : $this: Sets initials_image_uri
setIsAdmin() : $this: Sets is_admin
setIsAlternateAdmin() : $this: Sets is_alternate_admin
setIsNarEnabled() : $this: Sets is_nar_enabled
setJobTitle() : $this: Sets job_title
setLastLogin() : $this: Sets last_login
setLastName() : $this: Sets last_name
setLoginStatus() : $this: Sets login_status
setMiddleName() : $this: Sets middle_name
setPassword() : $this: Sets password
setPasswordExpiration() : $this: Sets password_expiration
setPermissionProfileId() : $this: Sets permission_profile_id
setPermissionProfileName() : $this: Sets permission_profile_name
setProfileImageUri() : $this: Sets profile_image_uri
setSendActivationEmail() : $this: Sets send_activation_email
setSendActivationOnInvalidLogin() : $this: Sets send_activation_on_invalid_login
setSignatureImageUri() : $this: Sets signature_image_uri
setSubscribe() : $this: Sets subscribe
setSuffixName() : $this: Sets suffix_name
setters() : array<string|int, mixed>: Array of attributes to setter functions (for deserialization of responses)
setTitle() : $this: Sets title
setUri() : $this: Sets uri
setUserAddedToAccountDateTime() : $this: Sets user_added_to_account_date_time
setUserId() : $this: Sets user_id
setUserName() : $this: Sets user_name
setUserProfileLastModifiedDate() : $this: Sets user_profile_last_modified_date
setUserSettings() : $this: Sets user_settings
setUserStatus() : $this: Sets user_status
setUserType() : $this: Sets user_type
setWorkAddress() : $this: Sets work_address
swaggerFormats() : array<string|int, mixed>: Array of property to format mappings. Used for (de)serialization
swaggerTypes() : array<string|int, mixed>: Array of property to type mappings. Used for (de)serialization
valid() : bool: Validate all the properties in the model return true if all passed

DISCRIMINATOR


    public
        mixed
    DISCRIMINATOR
    = null

$attributeMap

Array of attributes where the key is the local name, and the value is the original name


    protected
    static    array<string|int, string>
    $attributeMap
     = ['activation_access_code' => 'activationAccessCode', 'company' => 'company', 'connect_configurations' => 'connectConfigurations', 'country_code' => 'countryCode', 'created_date_time' => 'createdDateTime', 'custom_settings' => 'customSettings', 'default_account_id' => 'defaultAccountId', 'email' => 'email', 'enable_connect_for_user' => 'enableConnectForUser', 'error_details' => 'errorDetails', 'first_name' => 'firstName', 'forgotten_password_info' => 'forgottenPasswordInfo', 'group_list' => 'groupList', 'has_remote_notary' => 'hasRemoteNotary', 'home_address' => 'homeAddress', 'initials_image_uri' => 'initialsImageUri', 'is_admin' => 'isAdmin', 'is_alternate_admin' => 'isAlternateAdmin', 'is_nar_enabled' => 'isNAREnabled', 'job_title' => 'jobTitle', 'last_login' => 'lastLogin', 'last_name' => 'lastName', 'login_status' => 'loginStatus', 'middle_name' => 'middleName', 'password' => 'password', 'password_expiration' => 'passwordExpiration', 'permission_profile_id' => 'permissionProfileId', 'permission_profile_name' => 'permissionProfileName', 'profile_image_uri' => 'profileImageUri', 'send_activation_email' => 'sendActivationEmail', 'send_activation_on_invalid_login' => 'sendActivationOnInvalidLogin', 'signature_image_uri' => 'signatureImageUri', 'subscribe' => 'subscribe', 'suffix_name' => 'suffixName', 'title' => 'title', 'uri' => 'uri', 'user_added_to_account_date_time' => 'userAddedToAccountDateTime', 'user_id' => 'userId', 'user_name' => 'userName', 'user_profile_last_modified_date' => 'userProfileLastModifiedDate', 'user_settings' => 'userSettings', 'user_status' => 'userStatus', 'user_type' => 'userType', 'work_address' => 'workAddress']

$container

Associative array for storing property values


    protected
        array<string|int, mixed>
    $container
     = []

$getters

Array of attributes to getter functions (for serialization of requests)


    protected
    static    array<string|int, string>
    $getters
     = ['activation_access_code' => 'getActivationAccessCode', 'company' => 'getCompany', 'connect_configurations' => 'getConnectConfigurations', 'country_code' => 'getCountryCode', 'created_date_time' => 'getCreatedDateTime', 'custom_settings' => 'getCustomSettings', 'default_account_id' => 'getDefaultAccountId', 'email' => 'getEmail', 'enable_connect_for_user' => 'getEnableConnectForUser', 'error_details' => 'getErrorDetails', 'first_name' => 'getFirstName', 'forgotten_password_info' => 'getForgottenPasswordInfo', 'group_list' => 'getGroupList', 'has_remote_notary' => 'getHasRemoteNotary', 'home_address' => 'getHomeAddress', 'initials_image_uri' => 'getInitialsImageUri', 'is_admin' => 'getIsAdmin', 'is_alternate_admin' => 'getIsAlternateAdmin', 'is_nar_enabled' => 'getIsNarEnabled', 'job_title' => 'getJobTitle', 'last_login' => 'getLastLogin', 'last_name' => 'getLastName', 'login_status' => 'getLoginStatus', 'middle_name' => 'getMiddleName', 'password' => 'getPassword', 'password_expiration' => 'getPasswordExpiration', 'permission_profile_id' => 'getPermissionProfileId', 'permission_profile_name' => 'getPermissionProfileName', 'profile_image_uri' => 'getProfileImageUri', 'send_activation_email' => 'getSendActivationEmail', 'send_activation_on_invalid_login' => 'getSendActivationOnInvalidLogin', 'signature_image_uri' => 'getSignatureImageUri', 'subscribe' => 'getSubscribe', 'suffix_name' => 'getSuffixName', 'title' => 'getTitle', 'uri' => 'getUri', 'user_added_to_account_date_time' => 'getUserAddedToAccountDateTime', 'user_id' => 'getUserId', 'user_name' => 'getUserName', 'user_profile_last_modified_date' => 'getUserProfileLastModifiedDate', 'user_settings' => 'getUserSettings', 'user_status' => 'getUserStatus', 'user_type' => 'getUserType', 'work_address' => 'getWorkAddress']

$setters

Array of attributes to setter functions (for deserialization of responses)


    protected
    static    array<string|int, string>
    $setters
     = ['activation_access_code' => 'setActivationAccessCode', 'company' => 'setCompany', 'connect_configurations' => 'setConnectConfigurations', 'country_code' => 'setCountryCode', 'created_date_time' => 'setCreatedDateTime', 'custom_settings' => 'setCustomSettings', 'default_account_id' => 'setDefaultAccountId', 'email' => 'setEmail', 'enable_connect_for_user' => 'setEnableConnectForUser', 'error_details' => 'setErrorDetails', 'first_name' => 'setFirstName', 'forgotten_password_info' => 'setForgottenPasswordInfo', 'group_list' => 'setGroupList', 'has_remote_notary' => 'setHasRemoteNotary', 'home_address' => 'setHomeAddress', 'initials_image_uri' => 'setInitialsImageUri', 'is_admin' => 'setIsAdmin', 'is_alternate_admin' => 'setIsAlternateAdmin', 'is_nar_enabled' => 'setIsNarEnabled', 'job_title' => 'setJobTitle', 'last_login' => 'setLastLogin', 'last_name' => 'setLastName', 'login_status' => 'setLoginStatus', 'middle_name' => 'setMiddleName', 'password' => 'setPassword', 'password_expiration' => 'setPasswordExpiration', 'permission_profile_id' => 'setPermissionProfileId', 'permission_profile_name' => 'setPermissionProfileName', 'profile_image_uri' => 'setProfileImageUri', 'send_activation_email' => 'setSendActivationEmail', 'send_activation_on_invalid_login' => 'setSendActivationOnInvalidLogin', 'signature_image_uri' => 'setSignatureImageUri', 'subscribe' => 'setSubscribe', 'suffix_name' => 'setSuffixName', 'title' => 'setTitle', 'uri' => 'setUri', 'user_added_to_account_date_time' => 'setUserAddedToAccountDateTime', 'user_id' => 'setUserId', 'user_name' => 'setUserName', 'user_profile_last_modified_date' => 'setUserProfileLastModifiedDate', 'user_settings' => 'setUserSettings', 'user_status' => 'setUserStatus', 'user_type' => 'setUserType', 'work_address' => 'setWorkAddress']

$swaggerFormats

Array of property to format mappings. Used for (de)serialization


    protected
    static    array<string|int, string>
    $swaggerFormats
     = ['activation_access_code' => null, 'company' => null, 'connect_configurations' => null, 'country_code' => null, 'created_date_time' => null, 'custom_settings' => null, 'default_account_id' => null, 'email' => null, 'enable_connect_for_user' => null, 'error_details' => null, 'first_name' => null, 'forgotten_password_info' => null, 'group_list' => null, 'has_remote_notary' => null, 'home_address' => null, 'initials_image_uri' => null, 'is_admin' => null, 'is_alternate_admin' => null, 'is_nar_enabled' => null, 'job_title' => null, 'last_login' => null, 'last_name' => null, 'login_status' => null, 'middle_name' => null, 'password' => null, 'password_expiration' => null, 'permission_profile_id' => null, 'permission_profile_name' => null, 'profile_image_uri' => null, 'send_activation_email' => null, 'send_activation_on_invalid_login' => null, 'signature_image_uri' => null, 'subscribe' => null, 'suffix_name' => null, 'title' => null, 'uri' => null, 'user_added_to_account_date_time' => null, 'user_id' => null, 'user_name' => null, 'user_profile_last_modified_date' => null, 'user_settings' => null, 'user_status' => null, 'user_type' => null, 'work_address' => null]

$swaggerModelName

The original name of the model.


    protected
    static    string
    $swaggerModelName
     = 'userInformation'

$swaggerTypes

Array of property to type mappings. Used for (de)serialization


    protected
    static    array<string|int, string>
    $swaggerTypes
     = ['activation_access_code' => '?string', 'company' => '?string', 'connect_configurations' => '\\DocuSign\\eSign\\Model\\ConnectUserObject[]', 'country_code' => '?string', 'created_date_time' => '?string', 'custom_settings' => '\\DocuSign\\eSign\\Model\\NameValue[]', 'default_account_id' => '?string', 'email' => '?string', 'enable_connect_for_user' => '?string', 'error_details' => '\\DocuSign\\eSign\\Model\\ErrorDetails', 'first_name' => '?string', 'forgotten_password_info' => '\\DocuSign\\eSign\\Model\\ForgottenPasswordInformation', 'group_list' => '\\DocuSign\\eSign\\Model\\Group[]', 'has_remote_notary' => '?bool', 'home_address' => '\\DocuSign\\eSign\\Model\\AddressInformation', 'initials_image_uri' => '?string', 'is_admin' => '?string', 'is_alternate_admin' => '?string', 'is_nar_enabled' => '?string', 'job_title' => '?string', 'last_login' => '?string', 'last_name' => '?string', 'login_status' => '?string', 'middle_name' => '?string', 'password' => '?string', 'password_expiration' => '?string', 'permission_profile_id' => '?string', 'permission_profile_name' => '?string', 'profile_image_uri' => '?string', 'send_activation_email' => '?string', 'send_activation_on_invalid_login' => '?string', 'signature_image_uri' => '?string', 'subscribe' => '?string', 'suffix_name' => '?string', 'title' => '?string', 'uri' => '?string', 'user_added_to_account_date_time' => '?string', 'user_id' => '?string', 'user_name' => '?string', 'user_profile_last_modified_date' => '?string', 'user_settings' => '\\DocuSign\\eSign\\Model\\UserSettingsInformation', 'user_status' => '?string', 'user_type' => '?string', 'work_address' => '\\DocuSign\\eSign\\Model\\AddressInformation']

__construct()

Constructor


    public
                __construct([array<string|int, mixed> $data = null ]) : mixed

Parameters

$data : array<string|int, mixed> = null: Associated array of property values initializing the model

Return values

mixed —

__toString()

Gets the string presentation of the object


    public
                __toString() : string

Return values

string —

attributeMap()

Array of attributes where the key is the local name, and the value is the original name


    public
            static    attributeMap() : array<string|int, mixed>

Return values

array<string|int, mixed> —

getActivationAccessCode()

Gets activation_access_code


    public
                getActivationAccessCode() : string|null

Return values

string|null —

getCompany()

Gets company


    public
                getCompany() : string|null

Return values

string|null —

getConnectConfigurations()

Gets connect_configurations


    public
                getConnectConfigurations() : array<string|int, ConnectUserObject>

Return values

array<string|int, ConnectUserObject> —

getCountryCode()

Gets country_code


    public
                getCountryCode() : string|null

Return values

string|null —

getCreatedDateTime()

Gets created_date_time


    public
                getCreatedDateTime() : string|null

Return values

string|null —

getCustomSettings()

Gets custom_settings


    public
                getCustomSettings() : array<string|int, NameValue>

Return values

array<string|int, NameValue> —

getDefaultAccountId()

Gets default_account_id


    public
                getDefaultAccountId() : string|null

Return values

string|null —

getEmail()

Gets email


    public
                getEmail() : string|null

Return values

string|null —

getEnableConnectForUser()

Gets enable_connect_for_user


    public
                getEnableConnectForUser() : string|null

Return values

string|null —

getErrorDetails()

Gets error_details


    public
                getErrorDetails() : ErrorDetails

Return values

ErrorDetails —

getFirstName()

Gets first_name


    public
                getFirstName() : string|null

Return values

string|null —

getForgottenPasswordInfo()

Gets forgotten_password_info


    public
                getForgottenPasswordInfo() : ForgottenPasswordInformation

Return values

ForgottenPasswordInformation —

getGroupList()

Gets group_list


    public
                getGroupList() : array<string|int, Group>

Return values

array<string|int, Group> —

getHasRemoteNotary()

Gets has_remote_notary


    public
                getHasRemoteNotary() : bool|null

Return values

bool|null —

getHomeAddress()

Gets home_address


    public
                getHomeAddress() : AddressInformation

Return values

AddressInformation —

getInitialsImageUri()

Gets initials_image_uri


    public
                getInitialsImageUri() : string|null

Return values

string|null —

getIsAdmin()

Gets is_admin


    public
                getIsAdmin() : string|null

Return values

string|null —

getIsAlternateAdmin()

Gets is_alternate_admin


    public
                getIsAlternateAdmin() : string|null

Return values

string|null —

getIsNarEnabled()

Gets is_nar_enabled


    public
                getIsNarEnabled() : string|null

Return values

string|null —

getJobTitle()

Gets job_title


    public
                getJobTitle() : string|null

Return values

string|null —

getLastLogin()

Gets last_login


    public
                getLastLogin() : string|null

Return values

string|null —

getLastName()

Gets last_name


    public
                getLastName() : string|null

Return values

string|null —

getLoginStatus()

Gets login_status


    public
                getLoginStatus() : string|null

Return values

string|null —

getMiddleName()

Gets middle_name


    public
                getMiddleName() : string|null

Return values

string|null —

getModelName()

The original name of the model.


    public
                getModelName() : string

Return values

string —

getPassword()

Gets password


    public
                getPassword() : string|null

Return values

string|null —

getPasswordExpiration()

Gets password_expiration


    public
                getPasswordExpiration() : string|null

Return values

string|null —

getPermissionProfileId()

Gets permission_profile_id


    public
                getPermissionProfileId() : string|null

Return values

string|null —

getPermissionProfileName()

Gets permission_profile_name


    public
                getPermissionProfileName() : string|null

Return values

string|null —

getProfileImageUri()

Gets profile_image_uri


    public
                getProfileImageUri() : string|null

Return values

string|null —

getSendActivationEmail()

Gets send_activation_email


    public
                getSendActivationEmail() : string|null

Return values

string|null —

getSendActivationOnInvalidLogin()

Gets send_activation_on_invalid_login


    public
                getSendActivationOnInvalidLogin() : string|null

Return values

string|null —

getSignatureImageUri()

Gets signature_image_uri


    public
                getSignatureImageUri() : string|null

Return values

string|null —

getSubscribe()

Gets subscribe


    public
                getSubscribe() : string|null

Return values

string|null —

getSuffixName()

Gets suffix_name


    public
                getSuffixName() : string|null

Return values

string|null —

getters()

Array of attributes to getter functions (for serialization of requests)


    public
            static    getters() : array<string|int, mixed>

Return values

array<string|int, mixed> —

getTitle()

Gets title


    public
                getTitle() : string|null

Return values

string|null —

getUri()

Gets uri


    public
                getUri() : string|null

Return values

string|null —

getUserAddedToAccountDateTime()

Gets user_added_to_account_date_time


    public
                getUserAddedToAccountDateTime() : string|null

Return values

string|null —

getUserId()

Gets user_id


    public
                getUserId() : string|null

Return values

string|null —

getUserName()

Gets user_name


    public
                getUserName() : string|null

Return values

string|null —

getUserProfileLastModifiedDate()

Gets user_profile_last_modified_date


    public
                getUserProfileLastModifiedDate() : string|null

Return values

string|null —

getUserSettings()

Gets user_settings


    public
                getUserSettings() : UserSettingsInformation

Return values

UserSettingsInformation —

getUserStatus()

Gets user_status


    public
                getUserStatus() : string|null

Return values

string|null —

getUserType()

Gets user_type


    public
                getUserType() : string|null

Return values

string|null —

getWorkAddress()

Gets work_address


    public
                getWorkAddress() : AddressInformation

Return values

AddressInformation —

listInvalidProperties()

Show all the invalid properties with reasons.


    public
                listInvalidProperties() : array<string|int, mixed>

Return values

array<string|int, mixed> —

invalid properties with reasons

offsetExists()

Returns true if offset exists. False otherwise.


    public
                offsetExists(int $offset) : bool

Parameters

$offset : int: Offset

Return values

bool —

offsetGet()

Gets offset.


    public
                offsetGet(int $offset) : mixed

Parameters

$offset : int: Offset

Return values

mixed —

offsetSet()

Sets value based on offset.


    public
                offsetSet(int $offset, mixed $value) : void

Parameters

$offset : int: Offset
$value : mixed: Value to be set

Return values

void —

offsetUnset()

Unsets offset.


    public
                offsetUnset(int $offset) : void

Parameters

$offset : int: Offset

Return values

void —

setActivationAccessCode()

Sets activation_access_code


    public
                setActivationAccessCode(string|null $activation_access_code) : $this

Parameters

$activation_access_code : string|null: The activation code the new user must enter when activating their account.

Return values

$this —

setCompany()

Sets company


    public
                setCompany(string|null $company) : $this

Parameters

$company : string|null

Return values

$this —

setConnectConfigurations()

Sets connect_configurations


    public
                setConnectConfigurations(array<string|int, ConnectUserObject> $connect_configurations) : $this

Parameters

$connect_configurations : array<string|int, ConnectUserObject>

Return values

$this —

setCountryCode()

Sets country_code


    public
                setCountryCode(string|null $country_code) : $this

Parameters

$country_code : string|null

Return values

$this —

setCreatedDateTime()

Sets created_date_time


    public
                setCreatedDateTime(string|null $created_date_time) : $this

Parameters

$created_date_time : string|null: Indicates the date and time the item was created.

Return values

$this —

setCustomSettings()

Sets custom_settings


    public
                setCustomSettings(array<string|int, NameValue> $custom_settings) : $this

Parameters

$custom_settings : array<string|int, NameValue>: The name/value pair information for the user custom setting.

Return values

$this —

setDefaultAccountId()

Sets default_account_id


    public
                setDefaultAccountId(string|null $default_account_id) : $this

Parameters

$default_account_id : string|null

Return values

$this —

setEmail()

Sets email


    public
                setEmail(string|null $email) : $this

Parameters

$email : string|null

Return values

$this —

setEnableConnectForUser()

Sets enable_connect_for_user


    public
                setEnableConnectForUser(string|null $enable_connect_for_user) : $this

Parameters

$enable_connect_for_user : string|null: Specifies whether the user is enabled for updates from DocuSign Connect. Valid values: true or false.

Return values

$this —

setErrorDetails()

Sets error_details


    public
                setErrorDetails(ErrorDetails $error_details) : $this

Parameters

$error_details : ErrorDetails: Array or errors.

Return values

$this —

setFirstName()

Sets first_name


    public
                setFirstName(string|null $first_name) : $this

Parameters

$first_name : string|null: The user's first name. Maximum Length: 50 characters.

Return values

$this —

setForgottenPasswordInfo()

Sets forgotten_password_info


    public
                setForgottenPasswordInfo(ForgottenPasswordInformation $forgotten_password_info) : $this

Parameters

$forgotten_password_info : ForgottenPasswordInformation: A complex element containing up to four Question/Answer pairs for forgotten password information.

Return values

$this —

setGroupList()

Sets group_list


    public
                setGroupList(array<string|int, Group> $group_list) : $this

Parameters

$group_list : array<string|int, Group>: 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.

Return values

$this —

setHasRemoteNotary()

Sets has_remote_notary


    public
                setHasRemoteNotary(bool|null $has_remote_notary) : $this

Parameters

$has_remote_notary : bool|null

Return values

$this —

setHomeAddress()

Sets home_address


    public
                setHomeAddress(AddressInformation $home_address) : $this

Parameters

$home_address : AddressInformation: Specifies the email for the signing host. It is a Required element for In Person Signers recipient Type. Maximum Length: 100 characters.

Return values

$this —

setInitialsImageUri()

Sets initials_image_uri


    public
                setInitialsImageUri(string|null $initials_image_uri) : $this

Parameters

$initials_image_uri : string|null: Contains the URI for an endpoint that you can use to retrieve the initials image.

Return values

$this —

setIsAdmin()

Sets is_admin


    public
                setIsAdmin(string|null $is_admin) : $this

Parameters

$is_admin : string|null: Determines if the feature set is actively set as part of the plan.

Return values

$this —

setIsAlternateAdmin()

Sets is_alternate_admin


    public
                setIsAlternateAdmin(string|null $is_alternate_admin) : $this

Parameters

$is_alternate_admin : string|null

Return values

$this —

setIsNarEnabled()

Sets is_nar_enabled


    public
                setIsNarEnabled(string|null $is_nar_enabled) : $this

Parameters

$is_nar_enabled : string|null

Return values

$this —

setJobTitle()

Sets job_title


    public
                setJobTitle(string|null $job_title) : $this

Parameters

$job_title : string|null

Return values

$this —

setLastLogin()

Sets last_login


    public
                setLastLogin(string|null $last_login) : $this

Parameters

$last_login : string|null: Shows the date-time when the user last logged on to the system.

Return values

$this —

setLastName()

Sets last_name


    public
                setLastName(string|null $last_name) : $this

Parameters

$last_name : string|null: The user's last name. Maximum Length: 50 characters.

Return values

$this —

setLoginStatus()

Sets login_status


    public
                setLoginStatus(string|null $login_status) : $this

Parameters

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

Return values

$this —

setMiddleName()

Sets middle_name


    public
                setMiddleName(string|null $middle_name) : $this

Parameters

$middle_name : string|null: The user's middle name. Maximum Length: 50 characters.

Return values

$this —

setPassword()

Sets password


    public
                setPassword(string|null $password) : $this

Parameters

$password : string|null

Return values

$this —

setPasswordExpiration()

Sets password_expiration


    public
                setPasswordExpiration(string|null $password_expiration) : $this

Parameters

$password_expiration : string|null

Return values

$this —

setPermissionProfileId()

Sets permission_profile_id


    public
                setPermissionProfileId(string|null $permission_profile_id) : $this

Parameters

$permission_profile_id : string|null

Return values

$this —

setPermissionProfileName()

Sets permission_profile_name


    public
                setPermissionProfileName(string|null $permission_profile_name) : $this

Parameters

$permission_profile_name : string|null

Return values

$this —

setProfileImageUri()

Sets profile_image_uri


    public
                setProfileImageUri(string|null $profile_image_uri) : $this

Parameters

$profile_image_uri : string|null

Return values

$this —

setSendActivationEmail()

Sets send_activation_email


    public
                setSendActivationEmail(string|null $send_activation_email) : $this

Parameters

$send_activation_email : string|null

Return values

$this —

setSendActivationOnInvalidLogin()

Sets send_activation_on_invalid_login


    public
                setSendActivationOnInvalidLogin(string|null $send_activation_on_invalid_login) : $this

Parameters

$send_activation_on_invalid_login : string|null: 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.

Return values

$this —

setSignatureImageUri()

Sets signature_image_uri


    public
                setSignatureImageUri(string|null $signature_image_uri) : $this

Parameters

$signature_image_uri : string|null: Contains the URI for an endpoint that you can use to retrieve the signature image.

Return values

$this —

setSubscribe()

Sets subscribe


    public
                setSubscribe(string|null $subscribe) : $this

Parameters

$subscribe : string|null

Return values

$this —

setSuffixName()

Sets suffix_name


    public
                setSuffixName(string|null $suffix_name) : $this

Parameters

$suffix_name : string|null: The suffix for the user's name. Maximum Length: 50 characters.

Return values

$this —

setters()

Array of attributes to setter functions (for deserialization of responses)


    public
            static    setters() : array<string|int, mixed>

Return values

array<string|int, mixed> —

setTitle()

Sets title


    public
                setTitle(string|null $title) : $this

Parameters

$title : string|null: The title of the user.

Return values

$this —

setUri()

Sets uri


    public
                setUri(string|null $uri) : $this

Parameters

$uri : string|null

Return values

$this —

setUserAddedToAccountDateTime()

Sets user_added_to_account_date_time


    public
                setUserAddedToAccountDateTime(string|null $user_added_to_account_date_time) : $this

Parameters

$user_added_to_account_date_time : string|null

Return values

$this —

setUserId()

Sets user_id


    public
                setUserId(string|null $user_id) : $this

Parameters

$user_id : string|null

Return values

$this —

setUserName()

Sets user_name


    public
                setUserName(string|null $user_name) : $this

Parameters

$user_name : string|null

Return values

$this —

setUserProfileLastModifiedDate()

Sets user_profile_last_modified_date


    public
                setUserProfileLastModifiedDate(string|null $user_profile_last_modified_date) : $this

Parameters

$user_profile_last_modified_date : string|null

Return values

$this —

setUserSettings()

Sets user_settings


    public
                setUserSettings(UserSettingsInformation $user_settings) : $this

Parameters

$user_settings : UserSettingsInformation: 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.

Return values

$this —

setUserStatus()

Sets user_status


    public
                setUserStatus(string|null $user_status) : $this

Parameters

$user_status : string|null

Return values

$this —

setUserType()

Sets user_type


    public
                setUserType(string|null $user_type) : $this

Parameters

$user_type : string|null

Return values

$this —

setWorkAddress()

Sets work_address


    public
                setWorkAddress(AddressInformation $work_address) : $this

Parameters

$work_address : AddressInformation

Return values

$this —

swaggerFormats()

Array of property to format mappings. Used for (de)serialization


    public
            static    swaggerFormats() : array<string|int, mixed>

Return values

array<string|int, mixed> —

swaggerTypes()

Array of property to type mappings. Used for (de)serialization


    public
            static    swaggerTypes() : array<string|int, mixed>

Return values

array<string|int, mixed> —

valid()

Validate all the properties in the model return true if all passed


    public
                valid() : bool

Return values

bool —

True if all properties are valid

UserInformation in package DocuSign eSign implements ModelInterface, ArrayAccess

Tags

Interfaces, Classes, Traits and Enums

Table of Contents

Constants

DISCRIMINATOR

Properties

$attributeMap

$container

$getters

$setters

$swaggerFormats

$swaggerModelName

$swaggerTypes

Methods

__construct()

Parameters

Return values

__toString()

Return values

attributeMap()

Return values

getActivationAccessCode()

Return values

getCompany()

Return values

getConnectConfigurations()

Return values

getCountryCode()

Return values

getCreatedDateTime()

Return values

getCustomSettings()

Return values

getDefaultAccountId()

Return values

getEmail()

Return values

getEnableConnectForUser()

Return values

getErrorDetails()

Return values

getFirstName()

Return values

getForgottenPasswordInfo()

Return values

getGroupList()

Return values

getHasRemoteNotary()

Return values

getHomeAddress()

Return values

getInitialsImageUri()

Return values

getIsAdmin()

Return values

getIsAlternateAdmin()

Return values

getIsNarEnabled()

Return values

getJobTitle()

Return values

getLastLogin()

Return values

getLastName()

Return values

getLoginStatus()

Return values

getMiddleName()

Return values

getModelName()

Return values

getPassword()

Return values

getPasswordExpiration()

Return values

getPermissionProfileId()

Return values

getPermissionProfileName()

Return values

UserInformation
in package

DocuSign

eSign

implements ModelInterface, ArrayAccess