Documentation

IdCheckInformationInput
in package
implements ModelInterface, ArrayAccess

IdCheckInformationInput Class Doc Comment

Tags
category

Class

description

A complex element that contains input information related to a recipient ID check. It can include the following information. addressInformationInput: Used to set recipient address information and consists of: * addressInformation: consists of six elements, with stree2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4. The maximum length of each element is: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. dobInformationInput: Used to set recipient date of birth information and consists of: * dateOfBirth: Specifies the recipient's date, month and year of birth. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn4InformationInput: Used to set the last four digits of the recipient's SSN information and consists of: * ssn4: Specifies the last four digits of the recipient's SSN. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn9InformationInput: Used to set the recipient's SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of: * ssn9: Specifies the recipient's SSN. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.

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
getAddressInformationInput()  : AddressInformationInput
Gets address_information_input
getDobInformationInput()  : DobInformationInput
Gets dob_information_input
getModelName()  : string
The original name of the model.
getSsn4InformationInput()  : Ssn4InformationInput
Gets ssn4_information_input
getSsn9InformationInput()  : Ssn9InformationInput
Gets ssn9_information_input
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.
setAddressInformationInput()  : $this
Sets address_information_input
setDobInformationInput()  : $this
Sets dob_information_input
setSsn4InformationInput()  : $this
Sets ssn4_information_input
setSsn9InformationInput()  : $this
Sets ssn9_information_input
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 = ['address_information_input' => 'addressInformationInput', 'dob_information_input' => 'dobInformationInput', 'ssn4_information_input' => 'ssn4InformationInput', 'ssn9_information_input' => 'ssn9InformationInput']

$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 = ['address_information_input' => 'getAddressInformationInput', 'dob_information_input' => 'getDobInformationInput', 'ssn4_information_input' => 'getSsn4InformationInput', 'ssn9_information_input' => 'getSsn9InformationInput']

$setters

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

protected static array<string|int, string> $setters = ['address_information_input' => 'setAddressInformationInput', 'dob_information_input' => 'setDobInformationInput', 'ssn4_information_input' => 'setSsn4InformationInput', 'ssn9_information_input' => 'setSsn9InformationInput']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['address_information_input' => null, 'dob_information_input' => null, 'ssn4_information_input' => null, 'ssn9_information_input' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'idCheckInformationInput'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['address_information_input' => '\\DocuSign\\eSign\\Model\\AddressInformationInput', 'dob_information_input' => '\\DocuSign\\eSign\\Model\\DobInformationInput', 'ssn4_information_input' => '\\DocuSign\\eSign\\Model\\Ssn4InformationInput', 'ssn9_information_input' => '\\DocuSign\\eSign\\Model\\Ssn9InformationInput']

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> —

getModelName()

The original name of the model.

public getModelName() : string
Return values
string —

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 —

setDobInformationInput()

Sets dob_information_input

public setDobInformationInput(DobInformationInput $dob_information_input) : $this
Parameters
$dob_information_input : DobInformationInput

An object that specifies recipient date of birth information and how it is displayed.

Return values
$this —

setSsn4InformationInput()

Sets ssn4_information_input

public setSsn4InformationInput(Ssn4InformationInput $ssn4_information_input) : $this
Parameters
$ssn4_information_input : Ssn4InformationInput

An object that specifies the last four digits of the recipient's Social Security Number (SSN).

Return values
$this —

setSsn9InformationInput()

Sets ssn9_information_input

public setSsn9InformationInput(Ssn9InformationInput $ssn9_information_input) : $this
Parameters
$ssn9_information_input : Ssn9InformationInput

An object that specifies the recipient's Social Security Number (SSN) information. Note that ssn9 information cannot be returned in a response.

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