Documentation

AuthenticationStatus
in package
implements ModelInterface, ArrayAccess

AuthenticationStatus Class Doc Comment

Tags
category

Class

description

Contains information about the authentication status.

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
getAccessCodeResult()  : EventResult
Gets access_code_result
getAgeVerifyResult()  : EventResult
Gets age_verify_result
getAnySocialIdResult()  : EventResult
Gets any_social_id_result
getFacebookResult()  : EventResult
Gets facebook_result
getGoogleResult()  : EventResult
Gets google_result
getIdentityVerificationResult()  : EventResult
Gets identity_verification_result
getIdLookupResult()  : EventResult
Gets id_lookup_result
getIdQuestionsResult()  : EventResult
Gets id_questions_result
getLinkedinResult()  : EventResult
Gets linkedin_result
getLiveIdResult()  : EventResult
Gets live_id_result
getModelName()  : string
The original name of the model.
getOfacResult()  : EventResult
Gets ofac_result
getOpenIdResult()  : EventResult
Gets open_id_result
getPhoneAuthResult()  : EventResult
Gets phone_auth_result
getSalesforceResult()  : EventResult
Gets salesforce_result
getSignatureProviderResult()  : EventResult
Gets signature_provider_result
getSmsAuthResult()  : EventResult
Gets sms_auth_result
getSTanPinResult()  : EventResult
Gets s_tan_pin_result
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getTwitterResult()  : EventResult
Gets twitter_result
getYahooResult()  : EventResult
Gets yahoo_result
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.
setAccessCodeResult()  : $this
Sets access_code_result
setAgeVerifyResult()  : $this
Sets age_verify_result
setAnySocialIdResult()  : $this
Sets any_social_id_result
setFacebookResult()  : $this
Sets facebook_result
setGoogleResult()  : $this
Sets google_result
setIdentityVerificationResult()  : $this
Sets identity_verification_result
setIdLookupResult()  : $this
Sets id_lookup_result
setIdQuestionsResult()  : $this
Sets id_questions_result
setLinkedinResult()  : $this
Sets linkedin_result
setLiveIdResult()  : $this
Sets live_id_result
setOfacResult()  : $this
Sets ofac_result
setOpenIdResult()  : $this
Sets open_id_result
setPhoneAuthResult()  : $this
Sets phone_auth_result
setSalesforceResult()  : $this
Sets salesforce_result
setSignatureProviderResult()  : $this
Sets signature_provider_result
setSmsAuthResult()  : $this
Sets sms_auth_result
setSTanPinResult()  : $this
Sets s_tan_pin_result
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setTwitterResult()  : $this
Sets twitter_result
setYahooResult()  : $this
Sets yahoo_result
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 = ['access_code_result' => 'accessCodeResult', 'age_verify_result' => 'ageVerifyResult', 'any_social_id_result' => 'anySocialIDResult', 'facebook_result' => 'facebookResult', 'google_result' => 'googleResult', 'identity_verification_result' => 'identityVerificationResult', 'id_lookup_result' => 'idLookupResult', 'id_questions_result' => 'idQuestionsResult', 'linkedin_result' => 'linkedinResult', 'live_id_result' => 'liveIDResult', 'ofac_result' => 'ofacResult', 'open_id_result' => 'openIDResult', 'phone_auth_result' => 'phoneAuthResult', 'salesforce_result' => 'salesforceResult', 'signature_provider_result' => 'signatureProviderResult', 'sms_auth_result' => 'smsAuthResult', 's_tan_pin_result' => 'sTANPinResult', 'twitter_result' => 'twitterResult', 'yahoo_result' => 'yahooResult']

$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 = ['access_code_result' => 'getAccessCodeResult', 'age_verify_result' => 'getAgeVerifyResult', 'any_social_id_result' => 'getAnySocialIdResult', 'facebook_result' => 'getFacebookResult', 'google_result' => 'getGoogleResult', 'identity_verification_result' => 'getIdentityVerificationResult', 'id_lookup_result' => 'getIdLookupResult', 'id_questions_result' => 'getIdQuestionsResult', 'linkedin_result' => 'getLinkedinResult', 'live_id_result' => 'getLiveIdResult', 'ofac_result' => 'getOfacResult', 'open_id_result' => 'getOpenIdResult', 'phone_auth_result' => 'getPhoneAuthResult', 'salesforce_result' => 'getSalesforceResult', 'signature_provider_result' => 'getSignatureProviderResult', 'sms_auth_result' => 'getSmsAuthResult', 's_tan_pin_result' => 'getSTanPinResult', 'twitter_result' => 'getTwitterResult', 'yahoo_result' => 'getYahooResult']

$setters

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

protected static array<string|int, string> $setters = ['access_code_result' => 'setAccessCodeResult', 'age_verify_result' => 'setAgeVerifyResult', 'any_social_id_result' => 'setAnySocialIdResult', 'facebook_result' => 'setFacebookResult', 'google_result' => 'setGoogleResult', 'identity_verification_result' => 'setIdentityVerificationResult', 'id_lookup_result' => 'setIdLookupResult', 'id_questions_result' => 'setIdQuestionsResult', 'linkedin_result' => 'setLinkedinResult', 'live_id_result' => 'setLiveIdResult', 'ofac_result' => 'setOfacResult', 'open_id_result' => 'setOpenIdResult', 'phone_auth_result' => 'setPhoneAuthResult', 'salesforce_result' => 'setSalesforceResult', 'signature_provider_result' => 'setSignatureProviderResult', 'sms_auth_result' => 'setSmsAuthResult', 's_tan_pin_result' => 'setSTanPinResult', 'twitter_result' => 'setTwitterResult', 'yahoo_result' => 'setYahooResult']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['access_code_result' => null, 'age_verify_result' => null, 'any_social_id_result' => null, 'facebook_result' => null, 'google_result' => null, 'identity_verification_result' => null, 'id_lookup_result' => null, 'id_questions_result' => null, 'linkedin_result' => null, 'live_id_result' => null, 'ofac_result' => null, 'open_id_result' => null, 'phone_auth_result' => null, 'salesforce_result' => null, 'signature_provider_result' => null, 'sms_auth_result' => null, 's_tan_pin_result' => null, 'twitter_result' => null, 'yahoo_result' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'authenticationStatus'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['access_code_result' => '\\DocuSign\\eSign\\Model\\EventResult', 'age_verify_result' => '\\DocuSign\\eSign\\Model\\EventResult', 'any_social_id_result' => '\\DocuSign\\eSign\\Model\\EventResult', 'facebook_result' => '\\DocuSign\\eSign\\Model\\EventResult', 'google_result' => '\\DocuSign\\eSign\\Model\\EventResult', 'identity_verification_result' => '\\DocuSign\\eSign\\Model\\EventResult', 'id_lookup_result' => '\\DocuSign\\eSign\\Model\\EventResult', 'id_questions_result' => '\\DocuSign\\eSign\\Model\\EventResult', 'linkedin_result' => '\\DocuSign\\eSign\\Model\\EventResult', 'live_id_result' => '\\DocuSign\\eSign\\Model\\EventResult', 'ofac_result' => '\\DocuSign\\eSign\\Model\\EventResult', 'open_id_result' => '\\DocuSign\\eSign\\Model\\EventResult', 'phone_auth_result' => '\\DocuSign\\eSign\\Model\\EventResult', 'salesforce_result' => '\\DocuSign\\eSign\\Model\\EventResult', 'signature_provider_result' => '\\DocuSign\\eSign\\Model\\EventResult', 'sms_auth_result' => '\\DocuSign\\eSign\\Model\\EventResult', 's_tan_pin_result' => '\\DocuSign\\eSign\\Model\\EventResult', 'twitter_result' => '\\DocuSign\\eSign\\Model\\EventResult', 'yahoo_result' => '\\DocuSign\\eSign\\Model\\EventResult']

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 —

setAccessCodeResult()

Sets access_code_result

public setAccessCodeResult(EventResult $access_code_result) : $this
Parameters
$access_code_result : EventResult

The result of a user's attempt to authenticate by using an access code. It returns: - Status: Pass or Fail. - dateTime: The date and time that the event occurred. - FailureDescription: A string containing the details about a failed authentication. - VendorFailureStatusCode: A string containing the vendor's status code for a failed authentication.

Return values
$this —

setAgeVerifyResult()

Sets age_verify_result

public setAgeVerifyResult(EventResult $age_verify_result) : $this
Parameters
$age_verify_result : EventResult

The result of an age verification check. It returns: - Status: Pass or Fail. - dateTime: The date and time that the event occurred. - FailureDescription: A string containing the details about a failed authentication. - VendorFailureStatusCode: A string containing the vendor's status code for a failed authentication.

Return values
$this —

setAnySocialIdResult()

Sets any_social_id_result

public setAnySocialIdResult(EventResult $any_social_id_result) : $this
Parameters
$any_social_id_result : EventResult

Deprecated.

Return values
$this —

setIdentityVerificationResult()

Sets identity_verification_result

public setIdentityVerificationResult(EventResult $identity_verification_result) : $this
Parameters
$identity_verification_result : EventResult

The result of an [Identity Verification][IDV] workflow. [IDV]: /docs/esign-rest-api/reference/accounts/identityverifications/

Return values
$this —

setIdLookupResult()

Sets id_lookup_result

public setIdLookupResult(EventResult $id_lookup_result) : $this
Parameters
$id_lookup_result : EventResult

The result of an ID lookup authentication check. It returns: - Status: Pass or Fail. - dateTime: The date and time that the event occurred. - FailureDescription: A string containing the details about a failed authentication. - VendorFailureStatusCode: A string containing the vendor's status code for a failed authentication.

Return values
$this —

setIdQuestionsResult()

Sets id_questions_result

public setIdQuestionsResult(EventResult $id_questions_result) : $this
Parameters
$id_questions_result : EventResult

The result of the user's answers to ID challenge questions. It returns: - Status: Pass or Fail. - dateTime: The date and time that the event occurred. - FailureDescription: A string containing the details about a failed authentication. - VendorFailureStatusCode: A string containing the vendor's status code for a failed authentication.

Return values
$this —

setOfacResult()

Sets ofac_result

public setOfacResult(EventResult $ofac_result) : $this
Parameters
$ofac_result : EventResult

The result of an Office of Foreign Asset Control (OFAC) check. It returns: - Status: Pass or Fail. - dateTime: The date and time that the event occurred. - FailureDescription: A string containing the details about a failed authentication. - VendorFailureStatusCode: A string containing the vendor's status code for a failed authentication.

Return values
$this —

setPhoneAuthResult()

Sets phone_auth_result

public setPhoneAuthResult(EventResult $phone_auth_result) : $this
Parameters
$phone_auth_result : EventResult

The result of the user's attempt to authenticate by using two-factor authentication (2FA) through phone messaging. It returns: - Status: Pass or Fail. - dateTime: The date and time that the event occurred. - FailureDescription: A string containing the details about a failed authentication. - VendorFailureStatusCode: A string containing the vendor's status code for a failed authentication.

Return values
$this —

setSalesforceResult()

Sets salesforce_result

public setSalesforceResult(EventResult $salesforce_result) : $this
Parameters
$salesforce_result : EventResult

Success/failure result of authentication using sign-in with a Salesforce account. It returns: - Status: Pass or Fail. - dateTime: The date and time that the event occurred. - FailureDescription: A string containing the details about a failed authentication. - VendorFailureStatusCode: A string containing the vendor's status code for a failed authentication.

Return values
$this —

setSignatureProviderResult()

Sets signature_provider_result

public setSignatureProviderResult(EventResult $signature_provider_result) : $this
Parameters
$signature_provider_result : EventResult

The result of the user's attempt to authenticate by using a signature provider.

Return values
$this —

setSmsAuthResult()

Sets sms_auth_result

public setSmsAuthResult(EventResult $sms_auth_result) : $this
Parameters
$sms_auth_result : EventResult

The result of the user's attempt to authenticate by using two-factor authentication (2FA) through SMS messaging on a mobile phone.

Return values
$this —

setSTanPinResult()

Sets s_tan_pin_result

public setSTanPinResult(EventResult $s_tan_pin_result) : $this
Parameters
$s_tan_pin_result : EventResult

The result of a Student Authentication Network (STAN) authentication check. It returns: - Status: Pass or Fail. - dateTime: The date and time that the event occurred. - FailureDescription: A string containing the details about a failed authentication. - VendorFailureStatusCode: A string containing the vendor's status code for a failed authentication.

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