Documentation

SignSessionInfoRequest
in package
implements ModelInterface, ArrayAccess

SignSessionInfoRequest Class Doc Comment

Tags
category

Class

author

Swagger Codegen team

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
getCertificate()  : string|null
Gets certificate
getMaxSignatureLength()  : string|null
Gets max_signature_length
getModelName()  : string
The original name of the model.
getReturnFormat()  : string|null
Gets return_format
getSigningLocation()  : string|null
Gets signing_location
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.
setCertificate()  : $this
Sets certificate
setMaxSignatureLength()  : $this
Sets max_signature_length
setReturnFormat()  : $this
Sets return_format
setSigningLocation()  : $this
Sets signing_location
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 = ['certificate' => 'certificate', 'max_signature_length' => 'maxSignatureLength', 'return_format' => 'returnFormat', 'signing_location' => 'signingLocation']

$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 = ['certificate' => 'getCertificate', 'max_signature_length' => 'getMaxSignatureLength', 'return_format' => 'getReturnFormat', 'signing_location' => 'getSigningLocation']

$setters

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

protected static array<string|int, string> $setters = ['certificate' => 'setCertificate', 'max_signature_length' => 'setMaxSignatureLength', 'return_format' => 'setReturnFormat', 'signing_location' => 'setSigningLocation']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['certificate' => null, 'max_signature_length' => null, 'return_format' => null, 'signing_location' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'signSessionInfoRequest'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['certificate' => '?string', 'max_signature_length' => '?string', 'return_format' => '?string', 'signing_location' => '?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>

getCertificate()

Gets certificate

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

getMaxSignatureLength()

Gets max_signature_length

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

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getReturnFormat()

Gets return_format

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

getSigningLocation()

Gets signing_location

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

setCertificate()

Sets certificate

public setCertificate(string|null $certificate) : $this
Parameters
$certificate : string|null
Return values
$this

setMaxSignatureLength()

Sets max_signature_length

public setMaxSignatureLength(string|null $max_signature_length) : $this
Parameters
$max_signature_length : string|null
Return values
$this

setReturnFormat()

Sets return_format

public setReturnFormat(string|null $return_format) : $this
Parameters
$return_format : string|null
Return values
$this

setSigningLocation()

Sets signing_location

public setSigningLocation(string|null $signing_location) : $this
Parameters
$signing_location : string|null

Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online.

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