Documentation

UsageHistory
in package
implements ModelInterface, ArrayAccess

UsageHistory Class Doc Comment

Tags
category

Class

description

A complex element consisting of: * lastSentDateTime - the date and time the user last sent an envelope. * lastSignedDateTime - the date and time the user last signed an envelope. * sentCount - the number of envelopes the user has sent. * signedCount - the number of envelopes the user has signed.

author

Swagger Codegen team apihelp@docusign.com

license

The Docusign PHP Client SDK is licensed under the MIT License.

link
https://github.com/swagger-api/swagger-codegen

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
getLastSentDateTime()  : string|null
Gets last_sent_date_time
getLastSignedDateTime()  : string|null
Gets last_signed_date_time
getModelName()  : string
The original name of the model.
getSentCount()  : string|null
Gets sent_count
getSignedCount()  : string|null
Gets signed_count
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.
setLastSentDateTime()  : $this
Sets last_sent_date_time
setLastSignedDateTime()  : $this
Sets last_signed_date_time
setSentCount()  : $this
Sets sent_count
setSignedCount()  : $this
Sets signed_count
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

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 = ['last_sent_date_time' => 'lastSentDateTime', 'last_signed_date_time' => 'lastSignedDateTime', 'sent_count' => 'sentCount', 'signed_count' => 'signedCount']

$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 = ['last_sent_date_time' => 'getLastSentDateTime', 'last_signed_date_time' => 'getLastSignedDateTime', 'sent_count' => 'getSentCount', 'signed_count' => 'getSignedCount']

$setters

Array of attributes to setter functions (for deserialization of responses)

protected static array<string|int, string> $setters = ['last_sent_date_time' => 'setLastSentDateTime', 'last_signed_date_time' => 'setLastSignedDateTime', 'sent_count' => 'setSentCount', 'signed_count' => 'setSignedCount']

$swaggerFormats

Array of property to format mappings. Used for (de)serialization

protected static array<string|int, string> $swaggerFormats = ['last_sent_date_time' => null, 'last_signed_date_time' => null, 'sent_count' => null, 'signed_count' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'usageHistory'

$swaggerTypes

Array of property to type mappings. Used for (de)serialization

protected static array<string|int, string> $swaggerTypes = ['last_sent_date_time' => '?string', 'last_signed_date_time' => '?string', 'sent_count' => '?string', 'signed_count' => '?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> —

getLastSentDateTime()

Gets last_sent_date_time

public getLastSentDateTime() : string|null
Return values
string|null —

getLastSignedDateTime()

Gets last_signed_date_time

public getLastSignedDateTime() : string|null
Return values
string|null —

getModelName()

The original name of the model.

public getModelName() : string
Return values
string —

getSentCount()

Gets sent_count

public getSentCount() : string|null
Return values
string|null —

getSignedCount()

Gets signed_count

public getSignedCount() : 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 —

setLastSentDateTime()

Sets last_sent_date_time

public setLastSentDateTime(string|null $last_sent_date_time) : $this
Parameters
$last_sent_date_time : string|null

The date and time the user last sent an envelope.

Return values
$this —

setLastSignedDateTime()

Sets last_signed_date_time

public setLastSignedDateTime(string|null $last_signed_date_time) : $this
Parameters
$last_signed_date_time : string|null

The date and time the user last signed an envelope.

Return values
$this —

setSentCount()

Sets sent_count

public setSentCount(string|null $sent_count) : $this
Parameters
$sent_count : string|null

The number of envelopes the user has sent.

Return values
$this —

setSignedCount()

Sets signed_count

public setSignedCount(string|null $signed_count) : $this
Parameters
$signed_count : string|null

The number of envelopes the user has signed.

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

Search results