NotaryJournal
in package
implements
ModelInterface, ArrayAccess
NotaryJournal 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
- getCreatedDate() : string|null
- Gets created_date
- getDocumentName() : string|null
- Gets document_name
- getJurisdiction() : Jurisdiction
- Gets jurisdiction
- getModelName() : string
- The original name of the model.
- getNotaryJournalId() : string|null
- Gets notary_journal_id
- getNotaryJournalMetaData() : NotaryJournalMetaData
- Gets notary_journal_meta_data
- getSignerName() : string|null
- Gets signer_name
- 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.
- setCreatedDate() : $this
- Sets created_date
- setDocumentName() : $this
- Sets document_name
- setJurisdiction() : $this
- Sets jurisdiction
- setNotaryJournalId() : $this
- Sets notary_journal_id
- setNotaryJournalMetaData() : $this
- Sets notary_journal_meta_data
- setSignerName() : $this
- Sets signer_name
- 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
= ['created_date' => 'createdDate', 'document_name' => 'documentName', 'jurisdiction' => 'jurisdiction', 'notary_journal_id' => 'notaryJournalId', 'notary_journal_meta_data' => 'notaryJournalMetaData', 'signer_name' => 'signerName']
$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', 'document_name' => 'getDocumentName', 'jurisdiction' => 'getJurisdiction', 'notary_journal_id' => 'getNotaryJournalId', 'notary_journal_meta_data' => 'getNotaryJournalMetaData', 'signer_name' => 'getSignerName']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['created_date' => 'setCreatedDate', 'document_name' => 'setDocumentName', 'jurisdiction' => 'setJurisdiction', 'notary_journal_id' => 'setNotaryJournalId', 'notary_journal_meta_data' => 'setNotaryJournalMetaData', 'signer_name' => 'setSignerName']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['created_date' => null, 'document_name' => null, 'jurisdiction' => null, 'notary_journal_id' => null, 'notary_journal_meta_data' => null, 'signer_name' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'notaryJournal'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['created_date' => '?string', 'document_name' => '?string', 'jurisdiction' => '\\DocuSign\\eSign\\Model\\Jurisdiction', 'notary_journal_id' => '?string', 'notary_journal_meta_data' => '\\DocuSign\\eSign\\Model\\NotaryJournalMetaData', 'signer_name' => '?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> —getCreatedDate()
Gets created_date
public
getCreatedDate() : string|null
Return values
string|null —getDocumentName()
Gets document_name
public
getDocumentName() : string|null
Return values
string|null —getJurisdiction()
Gets jurisdiction
public
getJurisdiction() : Jurisdiction
Return values
Jurisdiction —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getNotaryJournalId()
Gets notary_journal_id
public
getNotaryJournalId() : string|null
Return values
string|null —getNotaryJournalMetaData()
Gets notary_journal_meta_data
public
getNotaryJournalMetaData() : NotaryJournalMetaData
Return values
NotaryJournalMetaData —getSignerName()
Gets signer_name
public
getSignerName() : 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 —setDocumentName()
Sets document_name
public
setDocumentName(string|null $document_name) : $this
Parameters
- $document_name : string|null
Return values
$this —setJurisdiction()
Sets jurisdiction
public
setJurisdiction(Jurisdiction $jurisdiction) : $this
Parameters
- $jurisdiction : Jurisdiction
-
The notary's jurisdiction.
Return values
$this —setNotaryJournalId()
Sets notary_journal_id
public
setNotaryJournalId(string|null $notary_journal_id) : $this
Parameters
- $notary_journal_id : string|null
Return values
$this —setNotaryJournalMetaData()
Sets notary_journal_meta_data
public
setNotaryJournalMetaData(NotaryJournalMetaData $notary_journal_meta_data) : $this
Parameters
- $notary_journal_meta_data : NotaryJournalMetaData
-
Additional journal data such as the witness list and signature image.
Return values
$this —setSignerName()
Sets signer_name
public
setSignerName(string|null $signer_name) : $this
Parameters
- $signer_name : 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