EnvelopesSharesResponseItem
in package
implements
ModelInterface, ArrayAccess
EnvelopesSharesResponseItem 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
- getCreatedTimestamp() : string|null
- Gets created_timestamp
- getEnvelopeId() : string|null
- Gets envelope_id
- getErrorDetails() : ErrorDetails
- Gets error_details
- getModelName() : string
- The original name of the model.
- getModifiedTimestamp() : string|null
- Gets modified_timestamp
- getPermission() : string|null
- Gets permission
- getSenderInfo() : AuthorizationUser
- Gets sender_info
- getShareId() : string|null
- Gets share_id
- getSubject() : string|null
- Gets subject
- 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
- setCreatedTimestamp() : $this
- Sets created_timestamp
- setEnvelopeId() : $this
- Sets envelope_id
- setErrorDetails() : $this
- Sets error_details
- setModifiedTimestamp() : $this
- Sets modified_timestamp
- setPermission() : $this
- Sets permission
- setSenderInfo() : $this
- Sets sender_info
- setShareId() : $this
- Sets share_id
- setSubject() : $this
- Sets subject
- 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', 'created_timestamp' => 'createdTimestamp', 'envelope_id' => 'envelopeId', 'error_details' => 'errorDetails', 'modified_timestamp' => 'modifiedTimestamp', 'permission' => 'permission', 'sender_info' => 'senderInfo', 'share_id' => 'shareId', 'subject' => 'subject']
$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', 'created_timestamp' => 'getCreatedTimestamp', 'envelope_id' => 'getEnvelopeId', 'error_details' => 'getErrorDetails', 'modified_timestamp' => 'getModifiedTimestamp', 'permission' => 'getPermission', 'sender_info' => 'getSenderInfo', 'share_id' => 'getShareId', 'subject' => 'getSubject']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['agent_user' => 'setAgentUser', 'created_timestamp' => 'setCreatedTimestamp', 'envelope_id' => 'setEnvelopeId', 'error_details' => 'setErrorDetails', 'modified_timestamp' => 'setModifiedTimestamp', 'permission' => 'setPermission', 'sender_info' => 'setSenderInfo', 'share_id' => 'setShareId', 'subject' => 'setSubject']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['agent_user' => null, 'created_timestamp' => null, 'envelope_id' => null, 'error_details' => null, 'modified_timestamp' => null, 'permission' => null, 'sender_info' => null, 'share_id' => null, 'subject' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'envelopesSharesResponseItem'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['agent_user' => '\\DocuSign\\eSign\\Model\\AuthorizationUser', 'created_timestamp' => '?string', 'envelope_id' => '?string', 'error_details' => '\\DocuSign\\eSign\\Model\\ErrorDetails', 'modified_timestamp' => '?string', 'permission' => '?string', 'sender_info' => '\\DocuSign\\eSign\\Model\\AuthorizationUser', 'share_id' => '?string', 'subject' => '?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 —getCreatedTimestamp()
Gets created_timestamp
public
getCreatedTimestamp() : string|null
Return values
string|null —getEnvelopeId()
Gets envelope_id
public
getEnvelopeId() : string|null
Return values
string|null —getErrorDetails()
Gets error_details
public
getErrorDetails() : ErrorDetails
Return values
ErrorDetails —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getModifiedTimestamp()
Gets modified_timestamp
public
getModifiedTimestamp() : string|null
Return values
string|null —getPermission()
Gets permission
public
getPermission() : string|null
Return values
string|null —getSenderInfo()
Gets sender_info
public
getSenderInfo() : AuthorizationUser
Return values
AuthorizationUser —getShareId()
Gets share_id
public
getShareId() : string|null
Return values
string|null —getSubject()
Gets subject
public
getSubject() : 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 —setCreatedTimestamp()
Sets created_timestamp
public
setCreatedTimestamp(string|null $created_timestamp) : $this
Parameters
- $created_timestamp : string|null
Return values
$this —setEnvelopeId()
Sets envelope_id
public
setEnvelopeId(string|null $envelope_id) : $this
Parameters
- $envelope_id : string|null
-
The envelope ID of the envelope status that failed to post.
Return values
$this —setErrorDetails()
Sets error_details
public
setErrorDetails(ErrorDetails $error_details) : $this
Parameters
- $error_details : ErrorDetails
-
Array or errors.
Return values
$this —setModifiedTimestamp()
Sets modified_timestamp
public
setModifiedTimestamp(string|null $modified_timestamp) : $this
Parameters
- $modified_timestamp : string|null
Return values
$this —setPermission()
Sets permission
public
setPermission(string|null $permission) : $this
Parameters
- $permission : string|null
Return values
$this —setSenderInfo()
Sets sender_info
public
setSenderInfo(AuthorizationUser $sender_info) : $this
Parameters
- $sender_info : AuthorizationUser
Return values
$this —setShareId()
Sets share_id
public
setShareId(string|null $share_id) : $this
Parameters
- $share_id : string|null
Return values
$this —setSubject()
Sets subject
public
setSubject(string|null $subject) : $this
Parameters
- $subject : 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