TspHealthCheckRequest
in package
implements
ModelInterface, ArrayAccess
TspHealthCheckRequest 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
- getAppVersion() : string|null
- Gets app_version
- getDescription() : string|null
- Gets description
- getError() : string|null
- Gets error
- getModelName() : string
- The original name of the model.
- getStatus() : string|null
- Gets status
- getStatusDescription() : array<string|int, TspHealthCheckStatusDescription>
- Gets status_description
- 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.
- setAppVersion() : $this
- Sets app_version
- setDescription() : $this
- Sets description
- setError() : $this
- Sets error
- setStatus() : $this
- Sets status
- setStatusDescription() : $this
- Sets status_description
- 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
= ['app_version' => 'appVersion', 'description' => 'description', 'error' => 'error', 'status' => 'status', 'status_description' => 'statusDescription']
$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
= ['app_version' => 'getAppVersion', 'description' => 'getDescription', 'error' => 'getError', 'status' => 'getStatus', 'status_description' => 'getStatusDescription']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['app_version' => 'setAppVersion', 'description' => 'setDescription', 'error' => 'setError', 'status' => 'setStatus', 'status_description' => 'setStatusDescription']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['app_version' => null, 'description' => null, 'error' => null, 'status' => null, 'status_description' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'tspHealthCheckRequest'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['app_version' => '?string', 'description' => '?string', 'error' => '?string', 'status' => '?string', 'status_description' => '\\DocuSign\\eSign\\Model\\TspHealthCheckStatusDescription[]']
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> —getAppVersion()
Gets app_version
public
getAppVersion() : string|null
Return values
string|null —getDescription()
Gets description
public
getDescription() : string|null
Return values
string|null —getError()
Gets error
public
getError() : string|null
Return values
string|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getStatus()
Gets status
public
getStatus() : string|null
Return values
string|null —getStatusDescription()
Gets status_description
public
getStatusDescription() : array<string|int, TspHealthCheckStatusDescription>
Return values
array<string|int, TspHealthCheckStatusDescription> —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 —setAppVersion()
Sets app_version
public
setAppVersion(string|null $app_version) : $this
Parameters
- $app_version : string|null
Return values
$this —setDescription()
Sets description
public
setDescription(string|null $description) : $this
Parameters
- $description : string|null
Return values
$this —setError()
Sets error
public
setError(string|null $error) : $this
Parameters
- $error : string|null
Return values
$this —setStatus()
Sets status
public
setStatus(string|null $status) : $this
Parameters
- $status : string|null
-
Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.
Return values
$this —setStatusDescription()
Sets status_description
public
setStatusDescription(array<string|int, TspHealthCheckStatusDescription> $status_description) : $this
Parameters
- $status_description : array<string|int, TspHealthCheckStatusDescription>
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