TemplateCompletionRateResponse
in package
implements
ModelInterface, ArrayAccess
TemplateCompletionRateResponse 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
- getBottomSenders() : array<string|int, SenderCompletionInfo>
- Gets bottom_senders
- getCompleted() : string|null
- Gets completed
- getCompletionRate() : string|null
- Gets completion_rate
- getExpired() : string|null
- Gets expired
- getExpiredRate() : string|null
- Gets expired_rate
- getModelName() : string
- The original name of the model.
- getSent() : string|null
- Gets sent
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getTopSenders() : array<string|int, SenderCompletionInfo>
- Gets top_senders
- getVoided() : string|null
- Gets voided
- getVoidedRate() : string|null
- Gets voided_rate
- 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.
- setBottomSenders() : $this
- Sets bottom_senders
- setCompleted() : $this
- Sets completed
- setCompletionRate() : $this
- Sets completion_rate
- setExpired() : $this
- Sets expired
- setExpiredRate() : $this
- Sets expired_rate
- setSent() : $this
- Sets sent
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setTopSenders() : $this
- Sets top_senders
- setVoided() : $this
- Sets voided
- setVoidedRate() : $this
- Sets voided_rate
- 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
= ['bottom_senders' => 'bottomSenders', 'completed' => 'completed', 'completion_rate' => 'completionRate', 'expired' => 'expired', 'expired_rate' => 'expiredRate', 'sent' => 'sent', 'top_senders' => 'topSenders', 'voided' => 'voided', 'voided_rate' => 'voidedRate']
$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
= ['bottom_senders' => 'getBottomSenders', 'completed' => 'getCompleted', 'completion_rate' => 'getCompletionRate', 'expired' => 'getExpired', 'expired_rate' => 'getExpiredRate', 'sent' => 'getSent', 'top_senders' => 'getTopSenders', 'voided' => 'getVoided', 'voided_rate' => 'getVoidedRate']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['bottom_senders' => 'setBottomSenders', 'completed' => 'setCompleted', 'completion_rate' => 'setCompletionRate', 'expired' => 'setExpired', 'expired_rate' => 'setExpiredRate', 'sent' => 'setSent', 'top_senders' => 'setTopSenders', 'voided' => 'setVoided', 'voided_rate' => 'setVoidedRate']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['bottom_senders' => null, 'completed' => 'int32', 'completion_rate' => 'double', 'expired' => 'int32', 'expired_rate' => 'double', 'sent' => 'int32', 'top_senders' => null, 'voided' => 'int32', 'voided_rate' => 'double']
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'templateCompletionRateResponse'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['bottom_senders' => '\\DocuSign\\eSign\\Model\\SenderCompletionInfo[]', 'completed' => '?string', 'completion_rate' => '?string', 'expired' => '?string', 'expired_rate' => '?string', 'sent' => '?string', 'top_senders' => '\\DocuSign\\eSign\\Model\\SenderCompletionInfo[]', 'voided' => '?string', 'voided_rate' => '?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> —getBottomSenders()
Gets bottom_senders
public
getBottomSenders() : array<string|int, SenderCompletionInfo>
Return values
array<string|int, SenderCompletionInfo> —getCompleted()
Gets completed
public
getCompleted() : string|null
Return values
string|null —getCompletionRate()
Gets completion_rate
public
getCompletionRate() : string|null
Return values
string|null —getExpired()
Gets expired
public
getExpired() : string|null
Return values
string|null —getExpiredRate()
Gets expired_rate
public
getExpiredRate() : string|null
Return values
string|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getSent()
Gets sent
public
getSent() : 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> —getTopSenders()
Gets top_senders
public
getTopSenders() : array<string|int, SenderCompletionInfo>
Return values
array<string|int, SenderCompletionInfo> —getVoided()
Gets voided
public
getVoided() : string|null
Return values
string|null —getVoidedRate()
Gets voided_rate
public
getVoidedRate() : 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 —setBottomSenders()
Sets bottom_senders
public
setBottomSenders(array<string|int, SenderCompletionInfo> $bottom_senders) : $this
Parameters
- $bottom_senders : array<string|int, SenderCompletionInfo>
Return values
$this —setCompleted()
Sets completed
public
setCompleted(string|null $completed) : $this
Parameters
- $completed : string|null
Return values
$this —setCompletionRate()
Sets completion_rate
public
setCompletionRate(string|null $completion_rate) : $this
Parameters
- $completion_rate : string|null
Return values
$this —setExpired()
Sets expired
public
setExpired(string|null $expired) : $this
Parameters
- $expired : string|null
Return values
$this —setExpiredRate()
Sets expired_rate
public
setExpiredRate(string|null $expired_rate) : $this
Parameters
- $expired_rate : string|null
Return values
$this —setSent()
Sets sent
public
setSent(string|null $sent) : $this
Parameters
- $sent : 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> —setTopSenders()
Sets top_senders
public
setTopSenders(array<string|int, SenderCompletionInfo> $top_senders) : $this
Parameters
- $top_senders : array<string|int, SenderCompletionInfo>
Return values
$this —setVoided()
Sets voided
public
setVoided(string|null $voided) : $this
Parameters
- $voided : string|null
Return values
$this —setVoidedRate()
Sets voided_rate
public
setVoidedRate(string|null $voided_rate) : $this
Parameters
- $voided_rate : string|null
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