WorkspaceUser
in package
implements
ModelInterface, ArrayAccess
WorkspaceUser 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
- getAccountId() : string|null
- Gets account_id
- getAccountName() : string|null
- Gets account_name
- getActiveSince() : string|null
- Gets active_since
- getCreated() : string|null
- Gets created
- getCreatedById() : string|null
- Gets created_by_id
- getEmail() : string|null
- Gets email
- getErrorDetails() : ErrorDetails
- Gets error_details
- getInvitationEmailBlurb() : string|null
- Gets invitation_email_blurb
- getInvitationEmailSubject() : string|null
- Gets invitation_email_subject
- getLastModified() : string|null
- Gets last_modified
- getLastModifiedById() : string|null
- Gets last_modified_by_id
- getModelName() : string
- The original name of the model.
- getStatus() : string|null
- Gets status
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getType() : string|null
- Gets type
- getUserId() : string|null
- Gets user_id
- getUserName() : string|null
- Gets user_name
- getWorkspaceId() : string|null
- Gets workspace_id
- getWorkspaceUserBaseUrl() : string|null
- Gets workspace_user_base_url
- getWorkspaceUserId() : string|null
- Gets workspace_user_id
- getWorkspaceUserUri() : string|null
- Gets workspace_user_uri
- 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
- setActiveSince() : $this
- Sets active_since
- setCreated() : $this
- Sets created
- setCreatedById() : $this
- Sets created_by_id
- setEmail() : $this
- Sets email
- setErrorDetails() : $this
- Sets error_details
- setInvitationEmailBlurb() : $this
- Sets invitation_email_blurb
- setInvitationEmailSubject() : $this
- Sets invitation_email_subject
- setLastModified() : $this
- Sets last_modified
- setLastModifiedById() : $this
- Sets last_modified_by_id
- setStatus() : $this
- Sets status
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setType() : $this
- Sets type
- setUserId() : $this
- Sets user_id
- setUserName() : $this
- Sets user_name
- setWorkspaceId() : $this
- Sets workspace_id
- setWorkspaceUserBaseUrl() : $this
- Sets workspace_user_base_url
- setWorkspaceUserId() : $this
- Sets workspace_user_id
- setWorkspaceUserUri() : $this
- Sets workspace_user_uri
- 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', 'active_since' => 'activeSince', 'created' => 'created', 'created_by_id' => 'createdById', 'email' => 'email', 'error_details' => 'errorDetails', 'invitation_email_blurb' => 'invitationEmailBlurb', 'invitation_email_subject' => 'invitationEmailSubject', 'last_modified' => 'lastModified', 'last_modified_by_id' => 'lastModifiedById', 'status' => 'status', 'type' => 'type', 'user_id' => 'userId', 'user_name' => 'userName', 'workspace_id' => 'workspaceId', 'workspace_user_base_url' => 'workspaceUserBaseUrl', 'workspace_user_id' => 'workspaceUserId', 'workspace_user_uri' => 'workspaceUserUri']
$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', 'active_since' => 'getActiveSince', 'created' => 'getCreated', 'created_by_id' => 'getCreatedById', 'email' => 'getEmail', 'error_details' => 'getErrorDetails', 'invitation_email_blurb' => 'getInvitationEmailBlurb', 'invitation_email_subject' => 'getInvitationEmailSubject', 'last_modified' => 'getLastModified', 'last_modified_by_id' => 'getLastModifiedById', 'status' => 'getStatus', 'type' => 'getType', 'user_id' => 'getUserId', 'user_name' => 'getUserName', 'workspace_id' => 'getWorkspaceId', 'workspace_user_base_url' => 'getWorkspaceUserBaseUrl', 'workspace_user_id' => 'getWorkspaceUserId', 'workspace_user_uri' => 'getWorkspaceUserUri']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['account_id' => 'setAccountId', 'account_name' => 'setAccountName', 'active_since' => 'setActiveSince', 'created' => 'setCreated', 'created_by_id' => 'setCreatedById', 'email' => 'setEmail', 'error_details' => 'setErrorDetails', 'invitation_email_blurb' => 'setInvitationEmailBlurb', 'invitation_email_subject' => 'setInvitationEmailSubject', 'last_modified' => 'setLastModified', 'last_modified_by_id' => 'setLastModifiedById', 'status' => 'setStatus', 'type' => 'setType', 'user_id' => 'setUserId', 'user_name' => 'setUserName', 'workspace_id' => 'setWorkspaceId', 'workspace_user_base_url' => 'setWorkspaceUserBaseUrl', 'workspace_user_id' => 'setWorkspaceUserId', 'workspace_user_uri' => 'setWorkspaceUserUri']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['account_id' => null, 'account_name' => null, 'active_since' => null, 'created' => null, 'created_by_id' => null, 'email' => null, 'error_details' => null, 'invitation_email_blurb' => null, 'invitation_email_subject' => null, 'last_modified' => null, 'last_modified_by_id' => null, 'status' => null, 'type' => null, 'user_id' => null, 'user_name' => null, 'workspace_id' => null, 'workspace_user_base_url' => null, 'workspace_user_id' => null, 'workspace_user_uri' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'workspaceUser'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['account_id' => '?string', 'account_name' => '?string', 'active_since' => '?string', 'created' => '?string', 'created_by_id' => '?string', 'email' => '?string', 'error_details' => '\\DocuSign\\eSign\\Model\\ErrorDetails', 'invitation_email_blurb' => '?string', 'invitation_email_subject' => '?string', 'last_modified' => '?string', 'last_modified_by_id' => '?string', 'status' => '?string', 'type' => '?string', 'user_id' => '?string', 'user_name' => '?string', 'workspace_id' => '?string', 'workspace_user_base_url' => '?string', 'workspace_user_id' => '?string', 'workspace_user_uri' => '?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 —getActiveSince()
Gets active_since
public
getActiveSince() : string|null
Return values
string|null —getCreated()
Gets created
public
getCreated() : string|null
Return values
string|null —getCreatedById()
Gets created_by_id
public
getCreatedById() : 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 —getInvitationEmailBlurb()
Gets invitation_email_blurb
public
getInvitationEmailBlurb() : string|null
Return values
string|null —getInvitationEmailSubject()
Gets invitation_email_subject
public
getInvitationEmailSubject() : string|null
Return values
string|null —getLastModified()
Gets last_modified
public
getLastModified() : string|null
Return values
string|null —getLastModifiedById()
Gets last_modified_by_id
public
getLastModifiedById() : string|null
Return values
string|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getStatus()
Gets status
public
getStatus() : 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> —getType()
Gets type
public
getType() : 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 —getWorkspaceId()
Gets workspace_id
public
getWorkspaceId() : string|null
Return values
string|null —getWorkspaceUserBaseUrl()
Gets workspace_user_base_url
public
getWorkspaceUserBaseUrl() : string|null
Return values
string|null —getWorkspaceUserId()
Gets workspace_user_id
public
getWorkspaceUserId() : string|null
Return values
string|null —getWorkspaceUserUri()
Gets workspace_user_uri
public
getWorkspaceUserUri() : 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
-
The name of the account that the workspace user belongs to.
Return values
$this —setActiveSince()
Sets active_since
public
setActiveSince(string|null $active_since) : $this
Parameters
- $active_since : string|null
Return values
$this —setCreated()
Sets created
public
setCreated(string|null $created) : $this
Parameters
- $created : string|null
-
The UTC DateTime when the workspace user was created.
Return values
$this —setCreatedById()
Sets created_by_id
public
setCreatedById(string|null $created_by_id) : $this
Parameters
- $created_by_id : 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 —setInvitationEmailBlurb()
Sets invitation_email_blurb
public
setInvitationEmailBlurb(string|null $invitation_email_blurb) : $this
Parameters
- $invitation_email_blurb : string|null
Return values
$this —setInvitationEmailSubject()
Sets invitation_email_subject
public
setInvitationEmailSubject(string|null $invitation_email_subject) : $this
Parameters
- $invitation_email_subject : string|null
Return values
$this —setLastModified()
Sets last_modified
public
setLastModified(string|null $last_modified) : $this
Parameters
- $last_modified : string|null
-
Utc date and time the comment was last updated (can only be done by creator.)
Return values
$this —setLastModifiedById()
Sets last_modified_by_id
public
setLastModifiedById(string|null $last_modified_by_id) : $this
Parameters
- $last_modified_by_id : string|null
Return values
$this —setStatus()
Sets status
public
setStatus(string|null $status) : $this
Parameters
- $status : string|null
-
Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.
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> —setType()
Sets type
public
setType(string|null $type) : $this
Parameters
- $type : string|null
-
Type of the user. Valid values: type_owner, type_participant.
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 —setWorkspaceId()
Sets workspace_id
public
setWorkspaceId(string|null $workspace_id) : $this
Parameters
- $workspace_id : string|null
Return values
$this —setWorkspaceUserBaseUrl()
Sets workspace_user_base_url
public
setWorkspaceUserBaseUrl(string|null $workspace_user_base_url) : $this
Parameters
- $workspace_user_base_url : string|null
-
The relative URI that may be used to access a workspace user.
Return values
$this —setWorkspaceUserId()
Sets workspace_user_id
public
setWorkspaceUserId(string|null $workspace_user_id) : $this
Parameters
- $workspace_user_id : string|null
Return values
$this —setWorkspaceUserUri()
Sets workspace_user_uri
public
setWorkspaceUserUri(string|null $workspace_user_uri) : $this
Parameters
- $workspace_user_uri : 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