UserProfile
in package
implements
ModelInterface, ArrayAccess
UserProfile Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
Table of Contents
- 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
- getAddress() : AddressInformation
- Gets address
- getAuthenticationMethods() : array<string|int, AuthenticationMethod>
- Gets authentication_methods
- getCompanyName() : string|null
- Gets company_name
- getDisplayOrganizationInfo() : string|null
- Gets display_organization_info
- getDisplayPersonalInfo() : string|null
- Gets display_personal_info
- getDisplayProfile() : string|null
- Gets display_profile
- getDisplayUsageHistory() : string|null
- Gets display_usage_history
- getModelName() : string
- The original name of the model.
- getProfileImageUri() : string|null
- Gets profile_image_uri
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getTitle() : string|null
- Gets title
- getUsageHistory() : UsageHistory
- Gets usage_history
- getUserDetails() : UserInformation
- Gets user_details
- getUserProfileLastModifiedDate() : string|null
- Gets user_profile_last_modified_date
- 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.
- setAddress() : $this
- Sets address
- setAuthenticationMethods() : $this
- Sets authentication_methods
- setCompanyName() : $this
- Sets company_name
- setDisplayOrganizationInfo() : $this
- Sets display_organization_info
- setDisplayPersonalInfo() : $this
- Sets display_personal_info
- setDisplayProfile() : $this
- Sets display_profile
- setDisplayUsageHistory() : $this
- Sets display_usage_history
- setProfileImageUri() : $this
- Sets profile_image_uri
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setTitle() : $this
- Sets title
- setUsageHistory() : $this
- Sets usage_history
- setUserDetails() : $this
- Sets user_details
- setUserProfileLastModifiedDate() : $this
- Sets user_profile_last_modified_date
- 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
Constants
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
Properties
$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
= ['address' => 'address', 'authentication_methods' => 'authenticationMethods', 'company_name' => 'companyName', 'display_organization_info' => 'displayOrganizationInfo', 'display_personal_info' => 'displayPersonalInfo', 'display_profile' => 'displayProfile', 'display_usage_history' => 'displayUsageHistory', 'profile_image_uri' => 'profileImageUri', 'title' => 'title', 'usage_history' => 'usageHistory', 'user_details' => 'userDetails', 'user_profile_last_modified_date' => 'userProfileLastModifiedDate']
$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
= ['address' => 'getAddress', 'authentication_methods' => 'getAuthenticationMethods', 'company_name' => 'getCompanyName', 'display_organization_info' => 'getDisplayOrganizationInfo', 'display_personal_info' => 'getDisplayPersonalInfo', 'display_profile' => 'getDisplayProfile', 'display_usage_history' => 'getDisplayUsageHistory', 'profile_image_uri' => 'getProfileImageUri', 'title' => 'getTitle', 'usage_history' => 'getUsageHistory', 'user_details' => 'getUserDetails', 'user_profile_last_modified_date' => 'getUserProfileLastModifiedDate']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['address' => 'setAddress', 'authentication_methods' => 'setAuthenticationMethods', 'company_name' => 'setCompanyName', 'display_organization_info' => 'setDisplayOrganizationInfo', 'display_personal_info' => 'setDisplayPersonalInfo', 'display_profile' => 'setDisplayProfile', 'display_usage_history' => 'setDisplayUsageHistory', 'profile_image_uri' => 'setProfileImageUri', 'title' => 'setTitle', 'usage_history' => 'setUsageHistory', 'user_details' => 'setUserDetails', 'user_profile_last_modified_date' => 'setUserProfileLastModifiedDate']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['address' => null, 'authentication_methods' => null, 'company_name' => null, 'display_organization_info' => null, 'display_personal_info' => null, 'display_profile' => null, 'display_usage_history' => null, 'profile_image_uri' => null, 'title' => null, 'usage_history' => null, 'user_details' => null, 'user_profile_last_modified_date' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'userProfile'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['address' => '\\DocuSign\\eSign\\Model\\AddressInformation', 'authentication_methods' => '\\DocuSign\\eSign\\Model\\AuthenticationMethod[]', 'company_name' => '?string', 'display_organization_info' => '?string', 'display_personal_info' => '?string', 'display_profile' => '?string', 'display_usage_history' => '?string', 'profile_image_uri' => '?string', 'title' => '?string', 'usage_history' => '\\DocuSign\\eSign\\Model\\UsageHistory', 'user_details' => '\\DocuSign\\eSign\\Model\\UserInformation', 'user_profile_last_modified_date' => '?string']
Methods
__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> —getAddress()
Gets address
public
getAddress() : AddressInformation
Return values
AddressInformation —getAuthenticationMethods()
Gets authentication_methods
public
getAuthenticationMethods() : array<string|int, AuthenticationMethod>
Return values
array<string|int, AuthenticationMethod> —getCompanyName()
Gets company_name
public
getCompanyName() : string|null
Return values
string|null —getDisplayOrganizationInfo()
Gets display_organization_info
public
getDisplayOrganizationInfo() : string|null
Return values
string|null —getDisplayPersonalInfo()
Gets display_personal_info
public
getDisplayPersonalInfo() : string|null
Return values
string|null —getDisplayProfile()
Gets display_profile
public
getDisplayProfile() : string|null
Return values
string|null —getDisplayUsageHistory()
Gets display_usage_history
public
getDisplayUsageHistory() : string|null
Return values
string|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getProfileImageUri()
Gets profile_image_uri
public
getProfileImageUri() : 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 —getUsageHistory()
Gets usage_history
public
getUsageHistory() : UsageHistory
Return values
UsageHistory —getUserDetails()
Gets user_details
public
getUserDetails() : UserInformation
Return values
UserInformation —getUserProfileLastModifiedDate()
Gets user_profile_last_modified_date
public
getUserProfileLastModifiedDate() : string|null
Return values
string|null —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 —setAddress()
Sets address
public
setAddress(AddressInformation $address) : $this
Parameters
- $address : AddressInformation
-
The user's address.
Return values
$this —setAuthenticationMethods()
Sets authentication_methods
public
setAuthenticationMethods(array<string|int, AuthenticationMethod> $authentication_methods) : $this
Parameters
- $authentication_methods : array<string|int, AuthenticationMethod>
-
These properties cannot be modified in the PUT. Indicates the authentication methods used by the user.
Return values
$this —setCompanyName()
Sets company_name
public
setCompanyName(string|null $company_name) : $this
Parameters
- $company_name : string|null
-
The name of the user's Company.
Return values
$this —setDisplayOrganizationInfo()
Sets display_organization_info
public
setDisplayOrganizationInfo(string|null $display_organization_info) : $this
Parameters
- $display_organization_info : string|null
-
When set to true, the user's company and title information are shown on the ID card.
Return values
$this —setDisplayPersonalInfo()
Sets display_personal_info
public
setDisplayPersonalInfo(string|null $display_personal_info) : $this
Parameters
- $display_personal_info : string|null
-
When set to true, the user's Address and Phone number are shown on the ID card.
Return values
$this —setDisplayProfile()
Sets display_profile
public
setDisplayProfile(string|null $display_profile) : $this
Parameters
- $display_profile : string|null
-
When set to true, the user's ID card can be viewed from signed documents and envelope history.
Return values
$this —setDisplayUsageHistory()
Sets display_usage_history
public
setDisplayUsageHistory(string|null $display_usage_history) : $this
Parameters
- $display_usage_history : string|null
-
When set to true, the user's usage information is shown on the ID card.
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 —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
Return values
$this —setUsageHistory()
Sets usage_history
public
setUsageHistory(UsageHistory $usage_history) : $this
Parameters
- $usage_history : UsageHistory
-
A complex element consisting of: -
lastSentDateTime: The date and time the user last sent an envelope. -lastSignedDateTime: The date and time the user last signed an envelope. -sentCount: The number of envelopes the user has sent. -signedCount: The number of envelopes the user has signed.
Return values
$this —setUserDetails()
Sets user_details
public
setUserDetails(UserInformation $user_details) : $this
Parameters
- $user_details : UserInformation
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 —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