Documentation

Ssn4InformationInput
in package
implements ModelInterface, ArrayAccess

Ssn4InformationInput 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
getDisplayLevelCode()  : string|null
Gets display_level_code
getModelName()  : string
The original name of the model.
getReceiveInResponse()  : string|null
Gets receive_in_response
getSsn4()  : string|null
Gets ssn4
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.
setDisplayLevelCode()  : $this
Sets display_level_code
setReceiveInResponse()  : $this
Sets receive_in_response
setSsn4()  : $this
Sets ssn4
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 = ['display_level_code' => 'displayLevelCode', 'receive_in_response' => 'receiveInResponse', 'ssn4' => 'ssn4']

$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 = ['display_level_code' => 'getDisplayLevelCode', 'receive_in_response' => 'getReceiveInResponse', 'ssn4' => 'getSsn4']

$setters

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

protected static array<string|int, string> $setters = ['display_level_code' => 'setDisplayLevelCode', 'receive_in_response' => 'setReceiveInResponse', 'ssn4' => 'setSsn4']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['display_level_code' => null, 'receive_in_response' => null, 'ssn4' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'ssn4InformationInput'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['display_level_code' => '?string', 'receive_in_response' => '?string', 'ssn4' => '?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>

getDisplayLevelCode()

Gets display_level_code

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

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getReceiveInResponse()

Gets receive_in_response

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

setDisplayLevelCode()

Sets display_level_code

public setDisplayLevelCode(string|null $display_level_code) : $this
Parameters
$display_level_code : string|null

Specifies the display level for the recipient. Valid values are: * ReadOnly * Editable * DoNotDisplay

Return values
$this

setReceiveInResponse()

Sets receive_in_response

public setReceiveInResponse(string|null $receive_in_response) : $this
Parameters
$receive_in_response : string|null

When set to true, the information needs to be returned in the response.

Return values
$this

setSsn4()

Sets ssn4

public setSsn4(string|null $ssn4) : $this
Parameters
$ssn4 : string|null

The last four digits of the recipient's Social Security Number (SSN).

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