Documentation

UserInfo
in package
implements ModelInterface, ArrayAccess

UserInfo 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
getAccountId()  : string|null
Gets account_id
getAccountName()  : string|null
Gets account_name
getActivationAccessCode()  : string|null
Gets activation_access_code
getEmail()  : string|null
Gets email
getErrorDetails()  : ErrorDetails
Gets error_details
getIpAddress()  : string|null
Gets ip_address
getLoginStatus()  : string|null
Gets login_status
getMembershipId()  : string|null
Gets membership_id
getModelName()  : string
The original name of the model.
getSendActivationEmail()  : string|null
Gets send_activation_email
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getUri()  : string|null
Gets uri
getUserId()  : string|null
Gets user_id
getUserName()  : string|null
Gets user_name
getUserStatus()  : string|null
Gets user_status
getUserType()  : string|null
Gets user_type
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.
setAccountId()  : $this
Sets account_id
setAccountName()  : $this
Sets account_name
setActivationAccessCode()  : $this
Sets activation_access_code
setEmail()  : $this
Sets email
setErrorDetails()  : $this
Sets error_details
setIpAddress()  : $this
Sets ip_address
setLoginStatus()  : $this
Sets login_status
setMembershipId()  : $this
Sets membership_id
setSendActivationEmail()  : $this
Sets send_activation_email
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setUri()  : $this
Sets uri
setUserId()  : $this
Sets user_id
setUserName()  : $this
Sets user_name
setUserStatus()  : $this
Sets user_status
setUserType()  : $this
Sets user_type
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 = ['account_id' => 'accountId', 'account_name' => 'accountName', 'activation_access_code' => 'activationAccessCode', 'email' => 'email', 'error_details' => 'errorDetails', 'ip_address' => 'ipAddress', 'login_status' => 'loginStatus', 'membership_id' => 'membershipId', 'send_activation_email' => 'sendActivationEmail', 'uri' => 'uri', 'user_id' => 'userId', 'user_name' => 'userName', 'user_status' => 'userStatus', 'user_type' => 'userType']

$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 = ['account_id' => 'getAccountId', 'account_name' => 'getAccountName', 'activation_access_code' => 'getActivationAccessCode', 'email' => 'getEmail', 'error_details' => 'getErrorDetails', 'ip_address' => 'getIpAddress', 'login_status' => 'getLoginStatus', 'membership_id' => 'getMembershipId', 'send_activation_email' => 'getSendActivationEmail', 'uri' => 'getUri', 'user_id' => 'getUserId', 'user_name' => 'getUserName', 'user_status' => 'getUserStatus', 'user_type' => 'getUserType']

$setters

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

protected static array<string|int, string> $setters = ['account_id' => 'setAccountId', 'account_name' => 'setAccountName', 'activation_access_code' => 'setActivationAccessCode', 'email' => 'setEmail', 'error_details' => 'setErrorDetails', 'ip_address' => 'setIpAddress', 'login_status' => 'setLoginStatus', 'membership_id' => 'setMembershipId', 'send_activation_email' => 'setSendActivationEmail', 'uri' => 'setUri', 'user_id' => 'setUserId', 'user_name' => 'setUserName', 'user_status' => 'setUserStatus', 'user_type' => 'setUserType']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['account_id' => null, 'account_name' => null, 'activation_access_code' => null, 'email' => null, 'error_details' => null, 'ip_address' => null, 'login_status' => null, 'membership_id' => null, 'send_activation_email' => null, 'uri' => null, 'user_id' => null, 'user_name' => null, 'user_status' => null, 'user_type' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'userInfo'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['account_id' => '?string', 'account_name' => '?string', 'activation_access_code' => '?string', 'email' => '?string', 'error_details' => '\\DocuSign\\eSign\\Model\\ErrorDetails', 'ip_address' => '?string', 'login_status' => '?string', 'membership_id' => '?string', 'send_activation_email' => '?string', 'uri' => '?string', 'user_id' => '?string', 'user_name' => '?string', 'user_status' => '?string', 'user_type' => '?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>

getAccountId()

Gets account_id

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

getAccountName()

Gets account_name

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

getActivationAccessCode()

Gets activation_access_code

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

getEmail()

Gets email

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

getIpAddress()

Gets ip_address

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

getLoginStatus()

Gets login_status

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

getMembershipId()

Gets membership_id

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

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getSendActivationEmail()

Gets send_activation_email

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

getUri()

Gets uri

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

getUserId()

Gets user_id

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

getUserName()

Gets user_name

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

getUserStatus()

Gets user_status

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

getUserType()

Gets user_type

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

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

setAccountId()

Sets account_id

public setAccountId(string|null $account_id) : $this
Parameters
$account_id : string|null

The account ID associated with the envelope.

Return values
$this

setAccountName()

Sets account_name

public setAccountName(string|null $account_name) : $this
Parameters
$account_name : string|null
Return values
$this

setActivationAccessCode()

Sets activation_access_code

public setActivationAccessCode(string|null $activation_access_code) : $this
Parameters
$activation_access_code : string|null
Return values
$this

setEmail()

Sets email

public setEmail(string|null $email) : $this
Parameters
$email : string|null
Return values
$this

setErrorDetails()

Sets error_details

public setErrorDetails(ErrorDetails $error_details) : $this
Parameters
$error_details : ErrorDetails

Array or errors.

Return values
$this

setIpAddress()

Sets ip_address

public setIpAddress(string|null $ip_address) : $this
Parameters
$ip_address : string|null
Return values
$this

setLoginStatus()

Sets login_status

public setLoginStatus(string|null $login_status) : $this
Parameters
$login_status : string|null
Return values
$this

setMembershipId()

Sets membership_id

public setMembershipId(string|null $membership_id) : $this
Parameters
$membership_id : string|null
Return values
$this

setSendActivationEmail()

Sets send_activation_email

public setSendActivationEmail(string|null $send_activation_email) : $this
Parameters
$send_activation_email : string|null
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>

setUri()

Sets uri

public setUri(string|null $uri) : $this
Parameters
$uri : string|null
Return values
$this

setUserId()

Sets user_id

public setUserId(string|null $user_id) : $this
Parameters
$user_id : string|null
Return values
$this

setUserName()

Sets user_name

public setUserName(string|null $user_name) : $this
Parameters
$user_name : string|null
Return values
$this

setUserStatus()

Sets user_status

public setUserStatus(string|null $user_status) : $this
Parameters
$user_status : string|null
Return values
$this

setUserType()

Sets user_type

public setUserType(string|null $user_type) : $this
Parameters
$user_type : string|null
Return values
$this

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