User
in package
implements
ModelInterface, ArrayAccess
User 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
- getCellPhoneNumber() : string|null
- Gets cell_phone_number
- getCountryCode() : string|null
- Gets country_code
- getCredentials() : array<string|int, Credential>
- Gets credentials
- getDisplayName() : string|null
- Gets display_name
- getEmail() : string|null
- Gets email
- getExternalClaims() : array<string|int, ExternalClaim>
- Gets external_claims
- getModelName() : string
- The original name of the model.
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- 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.
- setCellPhoneNumber() : $this
- Sets cell_phone_number
- setCountryCode() : $this
- Sets country_code
- setCredentials() : $this
- Sets credentials
- setDisplayName() : $this
- Sets display_name
- setEmail() : $this
- Sets email
- setExternalClaims() : $this
- Sets external_claims
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- 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
= ['cell_phone_number' => 'cellPhoneNumber', 'country_code' => 'countryCode', 'credentials' => 'credentials', 'display_name' => 'displayName', 'email' => 'email', 'external_claims' => 'externalClaims']
$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
= ['cell_phone_number' => 'getCellPhoneNumber', 'country_code' => 'getCountryCode', 'credentials' => 'getCredentials', 'display_name' => 'getDisplayName', 'email' => 'getEmail', 'external_claims' => 'getExternalClaims']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['cell_phone_number' => 'setCellPhoneNumber', 'country_code' => 'setCountryCode', 'credentials' => 'setCredentials', 'display_name' => 'setDisplayName', 'email' => 'setEmail', 'external_claims' => 'setExternalClaims']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['cell_phone_number' => null, 'country_code' => null, 'credentials' => null, 'display_name' => null, 'email' => null, 'external_claims' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'user'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['cell_phone_number' => '?string', 'country_code' => '?string', 'credentials' => '\\DocuSign\\eSign\\Model\\Credential[]', 'display_name' => '?string', 'email' => '?string', 'external_claims' => '\\DocuSign\\eSign\\Model\\ExternalClaim[]']
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> —getCellPhoneNumber()
Gets cell_phone_number
public
getCellPhoneNumber() : string|null
Return values
string|null —getCountryCode()
Gets country_code
public
getCountryCode() : string|null
Return values
string|null —getCredentials()
Gets credentials
public
getCredentials() : array<string|int, Credential>
Return values
array<string|int, Credential> —getDisplayName()
Gets display_name
public
getDisplayName() : string|null
Return values
string|null —getEmail()
Gets email
public
getEmail() : string|null
Return values
string|null —getExternalClaims()
Gets external_claims
public
getExternalClaims() : array<string|int, ExternalClaim>
Return values
array<string|int, ExternalClaim> —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —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 —setCellPhoneNumber()
Sets cell_phone_number
public
setCellPhoneNumber(string|null $cell_phone_number) : $this
Parameters
- $cell_phone_number : string|null
Return values
$this —setCountryCode()
Sets country_code
public
setCountryCode(string|null $country_code) : $this
Parameters
- $country_code : string|null
Return values
$this —setCredentials()
Sets credentials
public
setCredentials(array<string|int, Credential> $credentials) : $this
Parameters
- $credentials : array<string|int, Credential>
Return values
$this —setDisplayName()
Sets display_name
public
setDisplayName(string|null $display_name) : $this
Parameters
- $display_name : string|null
Return values
$this —setEmail()
Sets email
public
setEmail(string|null $email) : $this
Parameters
- $email : string|null
Return values
$this —setExternalClaims()
Sets external_claims
public
setExternalClaims(array<string|int, ExternalClaim> $external_claims) : $this
Parameters
- $external_claims : array<string|int, ExternalClaim>
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> —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