Documentation

Notary
in package
implements ModelInterface, ArrayAccess

Notary Class Doc Comment

Tags
category

Class

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
getCreatedDate()  : string|null
Gets created_date
getEnabled()  : string|null
Gets enabled
getModelName()  : string
The original name of the model.
getSearchable()  : string|null
Gets searchable
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getUserInfo()  : UserInformation
Gets user_info
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.
setCreatedDate()  : $this
Sets created_date
setEnabled()  : $this
Sets enabled
setSearchable()  : $this
Sets searchable
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setUserInfo()  : $this
Sets user_info
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 = ['created_date' => 'createdDate', 'enabled' => 'enabled', 'searchable' => 'searchable', 'user_info' => 'userInfo']

$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 = ['created_date' => 'getCreatedDate', 'enabled' => 'getEnabled', 'searchable' => 'getSearchable', 'user_info' => 'getUserInfo']

$setters

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

protected static array<string|int, string> $setters = ['created_date' => 'setCreatedDate', 'enabled' => 'setEnabled', 'searchable' => 'setSearchable', 'user_info' => 'setUserInfo']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['created_date' => null, 'enabled' => null, 'searchable' => null, 'user_info' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'notary'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['created_date' => '?string', 'enabled' => '?string', 'searchable' => '?string', 'user_info' => '\\DocuSign\\eSign\\Model\\UserInformation']

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>

getCreatedDate()

Gets created_date

public getCreatedDate() : string|null
Return values
string|null

getEnabled()

Gets enabled

public getEnabled() : string|null
Return values
string|null

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getSearchable()

Gets searchable

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

setCreatedDate()

Sets created_date

public setCreatedDate(string|null $created_date) : $this
Parameters
$created_date : string|null
Return values
$this

setEnabled()

Sets enabled

public setEnabled(string|null $enabled) : $this
Parameters
$enabled : string|null
Return values
$this

setSearchable()

Sets searchable

public setSearchable(string|null $searchable) : $this
Parameters
$searchable : 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>

setUserInfo()

Sets user_info

public setUserInfo(UserInformation $user_info) : $this
Parameters
$user_info : UserInformation

Information about the user registering to be a notary.

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

Search results