Workspace
in package
implements
ModelInterface, ArrayAccess
Workspace 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
- getBillableAccountId() : string|null
- Gets billable_account_id
- getCallerInformation() : WorkspaceUser
- Gets caller_information
- getCreated() : string|null
- Gets created
- getCreatedByInformation() : WorkspaceUser
- Gets created_by_information
- getLastModified() : string|null
- Gets last_modified
- getLastModifiedByInformation() : WorkspaceUser
- Gets last_modified_by_information
- getModelName() : string
- The original name of the model.
- getSettings() : WorkspaceSettings
- Gets settings
- getStatus() : string|null
- Gets status
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getWorkspaceBaseUrl() : string|null
- Gets workspace_base_url
- getWorkspaceDescription() : string|null
- Gets workspace_description
- getWorkspaceId() : string|null
- Gets workspace_id
- getWorkspaceName() : string|null
- Gets workspace_name
- getWorkspaceUri() : string|null
- Gets workspace_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.
- setBillableAccountId() : $this
- Sets billable_account_id
- setCallerInformation() : $this
- Sets caller_information
- setCreated() : $this
- Sets created
- setCreatedByInformation() : $this
- Sets created_by_information
- setLastModified() : $this
- Sets last_modified
- setLastModifiedByInformation() : $this
- Sets last_modified_by_information
- setSettings() : $this
- Sets settings
- setStatus() : $this
- Sets status
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setWorkspaceBaseUrl() : $this
- Sets workspace_base_url
- setWorkspaceDescription() : $this
- Sets workspace_description
- setWorkspaceId() : $this
- Sets workspace_id
- setWorkspaceName() : $this
- Sets workspace_name
- setWorkspaceUri() : $this
- Sets workspace_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
= ['billable_account_id' => 'billableAccountId', 'caller_information' => 'callerInformation', 'created' => 'created', 'created_by_information' => 'createdByInformation', 'last_modified' => 'lastModified', 'last_modified_by_information' => 'lastModifiedByInformation', 'settings' => 'settings', 'status' => 'status', 'workspace_base_url' => 'workspaceBaseUrl', 'workspace_description' => 'workspaceDescription', 'workspace_id' => 'workspaceId', 'workspace_name' => 'workspaceName', 'workspace_uri' => 'workspaceUri']
$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
= ['billable_account_id' => 'getBillableAccountId', 'caller_information' => 'getCallerInformation', 'created' => 'getCreated', 'created_by_information' => 'getCreatedByInformation', 'last_modified' => 'getLastModified', 'last_modified_by_information' => 'getLastModifiedByInformation', 'settings' => 'getSettings', 'status' => 'getStatus', 'workspace_base_url' => 'getWorkspaceBaseUrl', 'workspace_description' => 'getWorkspaceDescription', 'workspace_id' => 'getWorkspaceId', 'workspace_name' => 'getWorkspaceName', 'workspace_uri' => 'getWorkspaceUri']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['billable_account_id' => 'setBillableAccountId', 'caller_information' => 'setCallerInformation', 'created' => 'setCreated', 'created_by_information' => 'setCreatedByInformation', 'last_modified' => 'setLastModified', 'last_modified_by_information' => 'setLastModifiedByInformation', 'settings' => 'setSettings', 'status' => 'setStatus', 'workspace_base_url' => 'setWorkspaceBaseUrl', 'workspace_description' => 'setWorkspaceDescription', 'workspace_id' => 'setWorkspaceId', 'workspace_name' => 'setWorkspaceName', 'workspace_uri' => 'setWorkspaceUri']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['billable_account_id' => null, 'caller_information' => null, 'created' => null, 'created_by_information' => null, 'last_modified' => null, 'last_modified_by_information' => null, 'settings' => null, 'status' => null, 'workspace_base_url' => null, 'workspace_description' => null, 'workspace_id' => null, 'workspace_name' => null, 'workspace_uri' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'workspace'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['billable_account_id' => '?string', 'caller_information' => '\\DocuSign\\eSign\\Model\\WorkspaceUser', 'created' => '?string', 'created_by_information' => '\\DocuSign\\eSign\\Model\\WorkspaceUser', 'last_modified' => '?string', 'last_modified_by_information' => '\\DocuSign\\eSign\\Model\\WorkspaceUser', 'settings' => '\\DocuSign\\eSign\\Model\\WorkspaceSettings', 'status' => '?string', 'workspace_base_url' => '?string', 'workspace_description' => '?string', 'workspace_id' => '?string', 'workspace_name' => '?string', 'workspace_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> —getBillableAccountId()
Gets billable_account_id
public
getBillableAccountId() : string|null
Return values
string|null —getCallerInformation()
Gets caller_information
public
getCallerInformation() : WorkspaceUser
Return values
WorkspaceUser —getCreated()
Gets created
public
getCreated() : string|null
Return values
string|null —getCreatedByInformation()
Gets created_by_information
public
getCreatedByInformation() : WorkspaceUser
Return values
WorkspaceUser —getLastModified()
Gets last_modified
public
getLastModified() : string|null
Return values
string|null —getLastModifiedByInformation()
Gets last_modified_by_information
public
getLastModifiedByInformation() : WorkspaceUser
Return values
WorkspaceUser —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getSettings()
Gets settings
public
getSettings() : WorkspaceSettings
Return values
WorkspaceSettings —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> —getWorkspaceBaseUrl()
Gets workspace_base_url
public
getWorkspaceBaseUrl() : string|null
Return values
string|null —getWorkspaceDescription()
Gets workspace_description
public
getWorkspaceDescription() : string|null
Return values
string|null —getWorkspaceId()
Gets workspace_id
public
getWorkspaceId() : string|null
Return values
string|null —getWorkspaceName()
Gets workspace_name
public
getWorkspaceName() : string|null
Return values
string|null —getWorkspaceUri()
Gets workspace_uri
public
getWorkspaceUri() : 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 —setBillableAccountId()
Sets billable_account_id
public
setBillableAccountId(string|null $billable_account_id) : $this
Parameters
- $billable_account_id : string|null
Return values
$this —setCallerInformation()
Sets caller_information
public
setCallerInformation(WorkspaceUser $caller_information) : $this
Parameters
- $caller_information : WorkspaceUser
Return values
$this —setCreated()
Sets created
public
setCreated(string|null $created) : $this
Parameters
- $created : string|null
Return values
$this —setCreatedByInformation()
Sets created_by_information
public
setCreatedByInformation(WorkspaceUser $created_by_information) : $this
Parameters
- $created_by_information : WorkspaceUser
-
Details about the user who created the workspace.
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 —setLastModifiedByInformation()
Sets last_modified_by_information
public
setLastModifiedByInformation(WorkspaceUser $last_modified_by_information) : $this
Parameters
- $last_modified_by_information : WorkspaceUser
-
Details about the user who last modified the workspace.
Return values
$this —setSettings()
Sets settings
public
setSettings(WorkspaceSettings $settings) : $this
Parameters
- $settings : WorkspaceSettings
-
Information about the settings for the workspace.
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> —setWorkspaceBaseUrl()
Sets workspace_base_url
public
setWorkspaceBaseUrl(string|null $workspace_base_url) : $this
Parameters
- $workspace_base_url : string|null
-
The relative URL that may be used to access the workspace.
Return values
$this —setWorkspaceDescription()
Sets workspace_description
public
setWorkspaceDescription(string|null $workspace_description) : $this
Parameters
- $workspace_description : string|null
-
Text describing the purpose of the workspace.
Return values
$this —setWorkspaceId()
Sets workspace_id
public
setWorkspaceId(string|null $workspace_id) : $this
Parameters
- $workspace_id : string|null
-
The id of the workspace, always populated.
Return values
$this —setWorkspaceName()
Sets workspace_name
public
setWorkspaceName(string|null $workspace_name) : $this
Parameters
- $workspace_name : string|null
-
The name of the workspace.
Return values
$this —setWorkspaceUri()
Sets workspace_uri
public
setWorkspaceUri(string|null $workspace_uri) : $this
Parameters
- $workspace_uri : string|null
-
The relative URI that may be used to access the workspace.
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