Revision
in package
implements
ModelInterface, ArrayAccess
Revision 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
- getEndData() : string|null
- Gets end_data
- getFieldName() : string|null
- Gets field_name
- getMaxSignatureLength() : string|null
- Gets max_signature_length
- getModelName() : string
- The original name of the model.
- getSignatureProperties() : SignatureProperties
- Gets signature_properties
- getSignatureType() : string|null
- Gets signature_type
- getStartData() : string|null
- Gets start_data
- 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.
- setEndData() : $this
- Sets end_data
- setFieldName() : $this
- Sets field_name
- setMaxSignatureLength() : $this
- Sets max_signature_length
- setSignatureProperties() : $this
- Sets signature_properties
- setSignatureType() : $this
- Sets signature_type
- setStartData() : $this
- Sets start_data
- 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
= ['end_data' => 'endData', 'field_name' => 'fieldName', 'max_signature_length' => 'maxSignatureLength', 'signature_properties' => 'signatureProperties', 'signature_type' => 'signatureType', 'start_data' => 'startData']
$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
= ['end_data' => 'getEndData', 'field_name' => 'getFieldName', 'max_signature_length' => 'getMaxSignatureLength', 'signature_properties' => 'getSignatureProperties', 'signature_type' => 'getSignatureType', 'start_data' => 'getStartData']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['end_data' => 'setEndData', 'field_name' => 'setFieldName', 'max_signature_length' => 'setMaxSignatureLength', 'signature_properties' => 'setSignatureProperties', 'signature_type' => 'setSignatureType', 'start_data' => 'setStartData']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['end_data' => null, 'field_name' => null, 'max_signature_length' => null, 'signature_properties' => null, 'signature_type' => null, 'start_data' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'revision'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['end_data' => '?string', 'field_name' => '?string', 'max_signature_length' => '?string', 'signature_properties' => '\\DocuSign\\eSign\\Model\\SignatureProperties', 'signature_type' => '?string', 'start_data' => '?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> —getEndData()
Gets end_data
public
getEndData() : string|null
Return values
string|null —getFieldName()
Gets field_name
public
getFieldName() : string|null
Return values
string|null —getMaxSignatureLength()
Gets max_signature_length
public
getMaxSignatureLength() : string|null
Return values
string|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getSignatureProperties()
Gets signature_properties
public
getSignatureProperties() : SignatureProperties
Return values
SignatureProperties —getSignatureType()
Gets signature_type
public
getSignatureType() : string|null
Return values
string|null —getStartData()
Gets start_data
public
getStartData() : 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 —setEndData()
Sets end_data
public
setEndData(string|null $end_data) : $this
Parameters
- $end_data : string|null
Return values
$this —setFieldName()
Sets field_name
public
setFieldName(string|null $field_name) : $this
Parameters
- $field_name : string|null
Return values
$this —setMaxSignatureLength()
Sets max_signature_length
public
setMaxSignatureLength(string|null $max_signature_length) : $this
Parameters
- $max_signature_length : string|null
Return values
$this —setSignatureProperties()
Sets signature_properties
public
setSignatureProperties(SignatureProperties $signature_properties) : $this
Parameters
- $signature_properties : SignatureProperties
-
signature_properties
Return values
$this —setSignatureType()
Sets signature_type
public
setSignatureType(string|null $signature_type) : $this
Parameters
- $signature_type : string|null
Return values
$this —setStartData()
Sets start_data
public
setStartData(string|null $start_data) : $this
Parameters
- $start_data : 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