LoginAccount
in package
implements
ModelInterface, ArrayAccess
LoginAccount 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
- getAccountId() : string|null
- Gets account_id
- getAccountIdGuid() : string|null
- Gets account_id_guid
- getBaseUrl() : string|null
- Gets base_url
- getEmail() : string|null
- Gets email
- getIsDefault() : string|null
- Gets is_default
- getLoginAccountSettings() : array<string|int, NameValue>
- Gets login_account_settings
- getLoginUserSettings() : array<string|int, NameValue>
- Gets login_user_settings
- getModelName() : string
- The original name of the model.
- getName() : string|null
- Gets name
- getSiteDescription() : string|null
- Gets site_description
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getUserId() : string|null
- Gets user_id
- getUserName() : string|null
- Gets user_name
- 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.
- setAccountId() : $this
- Sets account_id
- setAccountIdGuid() : $this
- Sets account_id_guid
- setBaseUrl() : $this
- Sets base_url
- setEmail() : $this
- Sets email
- setIsDefault() : $this
- Sets is_default
- setLoginAccountSettings() : $this
- Sets login_account_settings
- setLoginUserSettings() : $this
- Sets login_user_settings
- setName() : $this
- Sets name
- setSiteDescription() : $this
- Sets site_description
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setUserId() : $this
- Sets user_id
- setUserName() : $this
- Sets user_name
- 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
= ['account_id' => 'accountId', 'account_id_guid' => 'accountIdGuid', 'base_url' => 'baseUrl', 'email' => 'email', 'is_default' => 'isDefault', 'login_account_settings' => 'loginAccountSettings', 'login_user_settings' => 'loginUserSettings', 'name' => 'name', 'site_description' => 'siteDescription', 'user_id' => 'userId', 'user_name' => 'userName']
$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
= ['account_id' => 'getAccountId', 'account_id_guid' => 'getAccountIdGuid', 'base_url' => 'getBaseUrl', 'email' => 'getEmail', 'is_default' => 'getIsDefault', 'login_account_settings' => 'getLoginAccountSettings', 'login_user_settings' => 'getLoginUserSettings', 'name' => 'getName', 'site_description' => 'getSiteDescription', 'user_id' => 'getUserId', 'user_name' => 'getUserName']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['account_id' => 'setAccountId', 'account_id_guid' => 'setAccountIdGuid', 'base_url' => 'setBaseUrl', 'email' => 'setEmail', 'is_default' => 'setIsDefault', 'login_account_settings' => 'setLoginAccountSettings', 'login_user_settings' => 'setLoginUserSettings', 'name' => 'setName', 'site_description' => 'setSiteDescription', 'user_id' => 'setUserId', 'user_name' => 'setUserName']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['account_id' => null, 'account_id_guid' => null, 'base_url' => null, 'email' => null, 'is_default' => null, 'login_account_settings' => null, 'login_user_settings' => null, 'name' => null, 'site_description' => null, 'user_id' => null, 'user_name' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'loginAccount'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['account_id' => '?string', 'account_id_guid' => '?string', 'base_url' => '?string', 'email' => '?string', 'is_default' => '?string', 'login_account_settings' => '\\DocuSign\\eSign\\Model\\NameValue[]', 'login_user_settings' => '\\DocuSign\\eSign\\Model\\NameValue[]', 'name' => '?string', 'site_description' => '?string', 'user_id' => '?string', 'user_name' => '?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> —getAccountId()
Gets account_id
public
getAccountId() : string|null
Return values
string|null —getAccountIdGuid()
Gets account_id_guid
public
getAccountIdGuid() : string|null
Return values
string|null —getBaseUrl()
Gets base_url
public
getBaseUrl() : string|null
Return values
string|null —getEmail()
Gets email
public
getEmail() : string|null
Return values
string|null —getIsDefault()
Gets is_default
public
getIsDefault() : string|null
Return values
string|null —getLoginAccountSettings()
Gets login_account_settings
public
getLoginAccountSettings() : array<string|int, NameValue>
Return values
array<string|int, NameValue> —getLoginUserSettings()
Gets login_user_settings
public
getLoginUserSettings() : array<string|int, NameValue>
Return values
array<string|int, NameValue> —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getName()
Gets name
public
getName() : string|null
Return values
string|null —getSiteDescription()
Gets site_description
public
getSiteDescription() : 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> —getUserId()
Gets user_id
public
getUserId() : string|null
Return values
string|null —getUserName()
Gets user_name
public
getUserName() : 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 —setAccountId()
Sets account_id
public
setAccountId(string|null $account_id) : $this
Parameters
- $account_id : string|null
-
The account ID associated with the envelope.
Return values
$this —setAccountIdGuid()
Sets account_id_guid
public
setAccountIdGuid(string|null $account_id_guid) : $this
Parameters
- $account_id_guid : string|null
-
The GUID associated with the account ID.
Return values
$this —setBaseUrl()
Sets base_url
public
setBaseUrl(string|null $base_url) : $this
Parameters
- $base_url : string|null
-
The URL that should be used for successive calls to this account. It includes the protocal (https), the DocuSign server where the account is located, and the account number. Use this Url to make API calls against this account. Many of the API calls provide Uri's that are relative to this baseUrl.
Return values
$this —setEmail()
Sets email
public
setEmail(string|null $email) : $this
Parameters
- $email : string|null
-
The email address for the user.
Return values
$this —setIsDefault()
Sets is_default
public
setIsDefault(string|null $is_default) : $this
Parameters
- $is_default : string|null
-
This value is true if this is the default account for the user, otherwise false is returned.
Return values
$this —setLoginAccountSettings()
Sets login_account_settings
public
setLoginAccountSettings(array<string|int, NameValue> $login_account_settings) : $this
Parameters
- $login_account_settings : array<string|int, NameValue>
-
A list of settings on the acccount that indicate what features are available.
Return values
$this —setLoginUserSettings()
Sets login_user_settings
public
setLoginUserSettings(array<string|int, NameValue> $login_user_settings) : $this
Parameters
- $login_user_settings : array<string|int, NameValue>
-
A list of user-level settings that indicate what user-specific features are available.
Return values
$this —setName()
Sets name
public
setName(string|null $name) : $this
Parameters
- $name : string|null
-
The name associated with the account.
Return values
$this —setSiteDescription()
Sets site_description
public
setSiteDescription(string|null $site_description) : $this
Parameters
- $site_description : string|null
-
An optional descirption of the site that hosts the account.
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> —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
-
The name of this user as defined by the account.
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