EnvelopeMetadata
in package
implements
ModelInterface, ArrayAccess
EnvelopeMetadata 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
- getAllowAdvancedCorrect() : string|null
- Gets allow_advanced_correct
- getAllowCorrect() : string|null
- Gets allow_correct
- getEnableSignWithNotary() : string|null
- Gets enable_sign_with_notary
- 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.
- setAllowAdvancedCorrect() : $this
- Sets allow_advanced_correct
- setAllowCorrect() : $this
- Sets allow_correct
- setEnableSignWithNotary() : $this
- Sets enable_sign_with_notary
- 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
= ['allow_advanced_correct' => 'allowAdvancedCorrect', 'allow_correct' => 'allowCorrect', 'enable_sign_with_notary' => 'enableSignWithNotary']
$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
= ['allow_advanced_correct' => 'getAllowAdvancedCorrect', 'allow_correct' => 'getAllowCorrect', 'enable_sign_with_notary' => 'getEnableSignWithNotary']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['allow_advanced_correct' => 'setAllowAdvancedCorrect', 'allow_correct' => 'setAllowCorrect', 'enable_sign_with_notary' => 'setEnableSignWithNotary']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['allow_advanced_correct' => null, 'allow_correct' => null, 'enable_sign_with_notary' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'envelopeMetadata'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['allow_advanced_correct' => '?string', 'allow_correct' => '?string', 'enable_sign_with_notary' => '?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> —getAllowAdvancedCorrect()
Gets allow_advanced_correct
public
getAllowAdvancedCorrect() : string|null
Return values
string|null —getAllowCorrect()
Gets allow_correct
public
getAllowCorrect() : string|null
Return values
string|null —getEnableSignWithNotary()
Gets enable_sign_with_notary
public
getEnableSignWithNotary() : string|null
Return values
string|null —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 —setAllowAdvancedCorrect()
Sets allow_advanced_correct
public
setAllowAdvancedCorrect(string|null $allow_advanced_correct) : $this
Parameters
- $allow_advanced_correct : string|null
Return values
$this —setAllowCorrect()
Sets allow_correct
public
setAllowCorrect(string|null $allow_correct) : $this
Parameters
- $allow_correct : string|null
Return values
$this —setEnableSignWithNotary()
Sets enable_sign_with_notary
public
setEnableSignWithNotary(string|null $enable_sign_with_notary) : $this
Parameters
- $enable_sign_with_notary : 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