UserAuthorization
in package
implements
ModelInterface, ArrayAccess
UserAuthorization 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
- getAgentUser() : AuthorizationUser
- Gets agent_user
- getAuthorizationId() : string|null
- Gets authorization_id
- getCreated() : string|null
- Gets created
- getCreatedBy() : string|null
- Gets created_by
- getEndDate() : string|null
- Gets end_date
- getModelName() : string
- The original name of the model.
- getModified() : string|null
- Gets modified
- getModifiedBy() : string|null
- Gets modified_by
- getPermission() : string|null
- Gets permission
- getPrincipalUser() : AuthorizationUser
- Gets principal_user
- getStartDate() : string|null
- Gets start_date
- 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.
- setAgentUser() : $this
- Sets agent_user
- setAuthorizationId() : $this
- Sets authorization_id
- setCreated() : $this
- Sets created
- setCreatedBy() : $this
- Sets created_by
- setEndDate() : $this
- Sets end_date
- setModified() : $this
- Sets modified
- setModifiedBy() : $this
- Sets modified_by
- setPermission() : $this
- Sets permission
- setPrincipalUser() : $this
- Sets principal_user
- setStartDate() : $this
- Sets start_date
- 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
= ['agent_user' => 'agentUser', 'authorization_id' => 'authorizationId', 'created' => 'created', 'created_by' => 'createdBy', 'end_date' => 'endDate', 'modified' => 'modified', 'modified_by' => 'modifiedBy', 'permission' => 'permission', 'principal_user' => 'principalUser', 'start_date' => 'startDate']
$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
= ['agent_user' => 'getAgentUser', 'authorization_id' => 'getAuthorizationId', 'created' => 'getCreated', 'created_by' => 'getCreatedBy', 'end_date' => 'getEndDate', 'modified' => 'getModified', 'modified_by' => 'getModifiedBy', 'permission' => 'getPermission', 'principal_user' => 'getPrincipalUser', 'start_date' => 'getStartDate']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['agent_user' => 'setAgentUser', 'authorization_id' => 'setAuthorizationId', 'created' => 'setCreated', 'created_by' => 'setCreatedBy', 'end_date' => 'setEndDate', 'modified' => 'setModified', 'modified_by' => 'setModifiedBy', 'permission' => 'setPermission', 'principal_user' => 'setPrincipalUser', 'start_date' => 'setStartDate']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['agent_user' => null, 'authorization_id' => null, 'created' => null, 'created_by' => null, 'end_date' => null, 'modified' => null, 'modified_by' => null, 'permission' => null, 'principal_user' => null, 'start_date' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'userAuthorization'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['agent_user' => '\\DocuSign\\eSign\\Model\\AuthorizationUser', 'authorization_id' => '?string', 'created' => '?string', 'created_by' => '?string', 'end_date' => '?string', 'modified' => '?string', 'modified_by' => '?string', 'permission' => '?string', 'principal_user' => '\\DocuSign\\eSign\\Model\\AuthorizationUser', 'start_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> —getAgentUser()
Gets agent_user
public
getAgentUser() : AuthorizationUser
Return values
AuthorizationUser —getAuthorizationId()
Gets authorization_id
public
getAuthorizationId() : string|null
Return values
string|null —getCreated()
Gets created
public
getCreated() : string|null
Return values
string|null —getCreatedBy()
Gets created_by
public
getCreatedBy() : string|null
Return values
string|null —getEndDate()
Gets end_date
public
getEndDate() : string|null
Return values
string|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getModified()
Gets modified
public
getModified() : string|null
Return values
string|null —getModifiedBy()
Gets modified_by
public
getModifiedBy() : string|null
Return values
string|null —getPermission()
Gets permission
public
getPermission() : string|null
Return values
string|null —getPrincipalUser()
Gets principal_user
public
getPrincipalUser() : AuthorizationUser
Return values
AuthorizationUser —getStartDate()
Gets start_date
public
getStartDate() : 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> —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 —setAgentUser()
Sets agent_user
public
setAgentUser(AuthorizationUser $agent_user) : $this
Parameters
- $agent_user : AuthorizationUser
Return values
$this —setAuthorizationId()
Sets authorization_id
public
setAuthorizationId(string|null $authorization_id) : $this
Parameters
- $authorization_id : string|null
Return values
$this —setCreated()
Sets created
public
setCreated(string|null $created) : $this
Parameters
- $created : string|null
Return values
$this —setCreatedBy()
Sets created_by
public
setCreatedBy(string|null $created_by) : $this
Parameters
- $created_by : string|null
Return values
$this —setEndDate()
Sets end_date
public
setEndDate(string|null $end_date) : $this
Parameters
- $end_date : string|null
Return values
$this —setModified()
Sets modified
public
setModified(string|null $modified) : $this
Parameters
- $modified : string|null
Return values
$this —setModifiedBy()
Sets modified_by
public
setModifiedBy(string|null $modified_by) : $this
Parameters
- $modified_by : string|null
Return values
$this —setPermission()
Sets permission
public
setPermission(string|null $permission) : $this
Parameters
- $permission : string|null
Return values
$this —setPrincipalUser()
Sets principal_user
public
setPrincipalUser(AuthorizationUser $principal_user) : $this
Parameters
- $principal_user : AuthorizationUser
Return values
$this —setStartDate()
Sets start_date
public
setStartDate(string|null $start_date) : $this
Parameters
- $start_date : 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> —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