NewUser
in package
implements
ModelInterface, ArrayAccess
NewUser Class Doc Comment
Tags
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
- getApiPassword() : string|null
- Gets api_password
- getCreatedDateTime() : string|null
- Gets created_date_time
- getEmail() : string|null
- Gets email
- getErrorDetails() : ErrorDetails
- Gets error_details
- getMembershipId() : string|null
- Gets membership_id
- getModelName() : string
- The original name of the model.
- getPermissionProfileId() : string|null
- Gets permission_profile_id
- getPermissionProfileName() : string|null
- Gets permission_profile_name
- 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
- 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.
- setApiPassword() : $this
- Sets api_password
- setCreatedDateTime() : $this
- Sets created_date_time
- setEmail() : $this
- Sets email
- setErrorDetails() : $this
- Sets error_details
- setMembershipId() : $this
- Sets membership_id
- setPermissionProfileId() : $this
- Sets permission_profile_id
- setPermissionProfileName() : $this
- Sets permission_profile_name
- 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
- 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
= ['api_password' => 'apiPassword', 'created_date_time' => 'createdDateTime', 'email' => 'email', 'error_details' => 'errorDetails', 'membership_id' => 'membershipId', 'permission_profile_id' => 'permissionProfileId', 'permission_profile_name' => 'permissionProfileName', 'uri' => 'uri', 'user_id' => 'userId', 'user_name' => 'userName', 'user_status' => 'userStatus']
$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
= ['api_password' => 'getApiPassword', 'created_date_time' => 'getCreatedDateTime', 'email' => 'getEmail', 'error_details' => 'getErrorDetails', 'membership_id' => 'getMembershipId', 'permission_profile_id' => 'getPermissionProfileId', 'permission_profile_name' => 'getPermissionProfileName', 'uri' => 'getUri', 'user_id' => 'getUserId', 'user_name' => 'getUserName', 'user_status' => 'getUserStatus']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['api_password' => 'setApiPassword', 'created_date_time' => 'setCreatedDateTime', 'email' => 'setEmail', 'error_details' => 'setErrorDetails', 'membership_id' => 'setMembershipId', 'permission_profile_id' => 'setPermissionProfileId', 'permission_profile_name' => 'setPermissionProfileName', 'uri' => 'setUri', 'user_id' => 'setUserId', 'user_name' => 'setUserName', 'user_status' => 'setUserStatus']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['api_password' => null, 'created_date_time' => null, 'email' => null, 'error_details' => null, 'membership_id' => null, 'permission_profile_id' => null, 'permission_profile_name' => null, 'uri' => null, 'user_id' => null, 'user_name' => null, 'user_status' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'newUser'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['api_password' => '?string', 'created_date_time' => '?string', 'email' => '?string', 'error_details' => '\\DocuSign\\eSign\\Model\\ErrorDetails', 'membership_id' => '?string', 'permission_profile_id' => '?string', 'permission_profile_name' => '?string', 'uri' => '?string', 'user_id' => '?string', 'user_name' => '?string', 'user_status' => '?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> —getApiPassword()
Gets api_password
public
getApiPassword() : string|null
Return values
string|null —getCreatedDateTime()
Gets created_date_time
public
getCreatedDateTime() : string|null
Return values
string|null —getEmail()
Gets email
public
getEmail() : string|null
Return values
string|null —getErrorDetails()
Gets error_details
public
getErrorDetails() : ErrorDetails
Return values
ErrorDetails —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 —getPermissionProfileId()
Gets permission_profile_id
public
getPermissionProfileId() : string|null
Return values
string|null —getPermissionProfileName()
Gets permission_profile_name
public
getPermissionProfileName() : 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 —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 —setApiPassword()
Sets api_password
public
setApiPassword(string|null $api_password) : $this
Parameters
- $api_password : string|null
-
Contains a token that can be used for authentication in API calls instead of using the user name and password.
Return values
$this —setCreatedDateTime()
Sets created_date_time
public
setCreatedDateTime(string|null $created_date_time) : $this
Parameters
- $created_date_time : string|null
-
Indicates the date and time the item was created.
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 —setMembershipId()
Sets membership_id
public
setMembershipId(string|null $membership_id) : $this
Parameters
- $membership_id : string|null
Return values
$this —setPermissionProfileId()
Sets permission_profile_id
public
setPermissionProfileId(string|null $permission_profile_id) : $this
Parameters
- $permission_profile_id : string|null
Return values
$this —setPermissionProfileName()
Sets permission_profile_name
public
setPermissionProfileName(string|null $permission_profile_name) : $this
Parameters
- $permission_profile_name : 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
-
Specifies the user ID for the new user.
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 —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