Folder
in package
implements
ModelInterface, ArrayAccess
Folder 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
- getErrorDetails() : ErrorDetails
- Gets error_details
- getFilter() : Filter
- Gets filter
- getFolderId() : string|null
- Gets folder_id
- getFolderItems() : array<string|int, FolderItemV2>
- Gets folder_items
- getFolders() : array<string|int, Folder>
- Gets folders
- getHasAccess() : string|null
- Gets has_access
- getHasSubFolders() : string|null
- Gets has_sub_folders
- getItemCount() : string|null
- Gets item_count
- getModelName() : string
- The original name of the model.
- getName() : string|null
- Gets name
- getOwner() : UserInfo
- Gets owner
- getParentFolderId() : string|null
- Gets parent_folder_id
- getParentFolderUri() : string|null
- Gets parent_folder_uri
- getSubFolderCount() : string|null
- Gets sub_folder_count
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getType() : string|null
- Gets type
- getUri() : string|null
- Gets 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.
- setErrorDetails() : $this
- Sets error_details
- setFilter() : $this
- Sets filter
- setFolderId() : $this
- Sets folder_id
- setFolderItems() : $this
- Sets folder_items
- setFolders() : $this
- Sets folders
- setHasAccess() : $this
- Sets has_access
- setHasSubFolders() : $this
- Sets has_sub_folders
- setItemCount() : $this
- Sets item_count
- setName() : $this
- Sets name
- setOwner() : $this
- Sets owner
- setParentFolderId() : $this
- Sets parent_folder_id
- setParentFolderUri() : $this
- Sets parent_folder_uri
- setSubFolderCount() : $this
- Sets sub_folder_count
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setType() : $this
- Sets type
- setUri() : $this
- Sets 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
= ['error_details' => 'errorDetails', 'filter' => 'filter', 'folder_id' => 'folderId', 'folder_items' => 'folderItems', 'folders' => 'folders', 'has_access' => 'hasAccess', 'has_sub_folders' => 'hasSubFolders', 'item_count' => 'itemCount', 'name' => 'name', 'owner' => 'owner', 'parent_folder_id' => 'parentFolderId', 'parent_folder_uri' => 'parentFolderUri', 'sub_folder_count' => 'subFolderCount', 'type' => 'type', 'uri' => 'uri']
$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
= ['error_details' => 'getErrorDetails', 'filter' => 'getFilter', 'folder_id' => 'getFolderId', 'folder_items' => 'getFolderItems', 'folders' => 'getFolders', 'has_access' => 'getHasAccess', 'has_sub_folders' => 'getHasSubFolders', 'item_count' => 'getItemCount', 'name' => 'getName', 'owner' => 'getOwner', 'parent_folder_id' => 'getParentFolderId', 'parent_folder_uri' => 'getParentFolderUri', 'sub_folder_count' => 'getSubFolderCount', 'type' => 'getType', 'uri' => 'getUri']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['error_details' => 'setErrorDetails', 'filter' => 'setFilter', 'folder_id' => 'setFolderId', 'folder_items' => 'setFolderItems', 'folders' => 'setFolders', 'has_access' => 'setHasAccess', 'has_sub_folders' => 'setHasSubFolders', 'item_count' => 'setItemCount', 'name' => 'setName', 'owner' => 'setOwner', 'parent_folder_id' => 'setParentFolderId', 'parent_folder_uri' => 'setParentFolderUri', 'sub_folder_count' => 'setSubFolderCount', 'type' => 'setType', 'uri' => 'setUri']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['error_details' => null, 'filter' => null, 'folder_id' => null, 'folder_items' => null, 'folders' => null, 'has_access' => null, 'has_sub_folders' => null, 'item_count' => null, 'name' => null, 'owner' => null, 'parent_folder_id' => null, 'parent_folder_uri' => null, 'sub_folder_count' => null, 'type' => null, 'uri' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'folder'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['error_details' => '\\DocuSign\\eSign\\Model\\ErrorDetails', 'filter' => '\\DocuSign\\eSign\\Model\\Filter', 'folder_id' => '?string', 'folder_items' => '\\DocuSign\\eSign\\Model\\FolderItemV2[]', 'folders' => '\\DocuSign\\eSign\\Model\\Folder[]', 'has_access' => '?string', 'has_sub_folders' => '?string', 'item_count' => '?string', 'name' => '?string', 'owner' => '\\DocuSign\\eSign\\Model\\UserInfo', 'parent_folder_id' => '?string', 'parent_folder_uri' => '?string', 'sub_folder_count' => '?string', 'type' => '?string', '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> —getErrorDetails()
Gets error_details
public
getErrorDetails() : ErrorDetails
Return values
ErrorDetails —getFilter()
Gets filter
public
getFilter() : Filter
Return values
Filter —getFolderId()
Gets folder_id
public
getFolderId() : string|null
Return values
string|null —getFolderItems()
Gets folder_items
public
getFolderItems() : array<string|int, FolderItemV2>
Return values
array<string|int, FolderItemV2> —getFolders()
Gets folders
public
getFolders() : array<string|int, Folder>
Return values
array<string|int, Folder> —getHasAccess()
Gets has_access
public
getHasAccess() : string|null
Return values
string|null —getHasSubFolders()
Gets has_sub_folders
public
getHasSubFolders() : string|null
Return values
string|null —getItemCount()
Gets item_count
public
getItemCount() : string|null
Return values
string|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getName()
Gets name
public
getName() : string|null
Return values
string|null —getOwner()
Gets owner
public
getOwner() : UserInfo
Return values
UserInfo —getParentFolderId()
Gets parent_folder_id
public
getParentFolderId() : string|null
Return values
string|null —getParentFolderUri()
Gets parent_folder_uri
public
getParentFolderUri() : string|null
Return values
string|null —getSubFolderCount()
Gets sub_folder_count
public
getSubFolderCount() : 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 —getUri()
Gets uri
public
getUri() : 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 —setErrorDetails()
Sets error_details
public
setErrorDetails(ErrorDetails $error_details) : $this
Parameters
- $error_details : ErrorDetails
-
Array or errors.
Return values
$this —setFilter()
Sets filter
public
setFilter(Filter $filter) : $this
Parameters
- $filter : Filter
-
An object used to present a filtered view of the items in a folder.
Return values
$this —setFolderId()
Sets folder_id
public
setFolderId(string|null $folder_id) : $this
Parameters
- $folder_id : string|null
Return values
$this —setFolderItems()
Sets folder_items
public
setFolderItems(array<string|int, FolderItemV2> $folder_items) : $this
Parameters
- $folder_items : array<string|int, FolderItemV2>
-
A list of the envelopes in the specified folder or folders.
Return values
$this —setFolders()
Sets folders
public
setFolders(array<string|int, Folder> $folders) : $this
Parameters
- $folders : array<string|int, Folder>
-
A collection of folder objects returned in a response.
Return values
$this —setHasAccess()
Sets has_access
public
setHasAccess(string|null $has_access) : $this
Parameters
- $has_access : string|null
Return values
$this —setHasSubFolders()
Sets has_sub_folders
public
setHasSubFolders(string|null $has_sub_folders) : $this
Parameters
- $has_sub_folders : string|null
Return values
$this —setItemCount()
Sets item_count
public
setItemCount(string|null $item_count) : $this
Parameters
- $item_count : string|null
Return values
$this —setName()
Sets name
public
setName(string|null $name) : $this
Parameters
- $name : string|null
Return values
$this —setOwner()
Sets owner
public
setOwner(UserInfo $owner) : $this
Parameters
- $owner : UserInfo
-
Information about the user who owns the folder.
Return values
$this —setParentFolderId()
Sets parent_folder_id
public
setParentFolderId(string|null $parent_folder_id) : $this
Parameters
- $parent_folder_id : string|null
Return values
$this —setParentFolderUri()
Sets parent_folder_uri
public
setParentFolderUri(string|null $parent_folder_uri) : $this
Parameters
- $parent_folder_uri : string|null
Return values
$this —setSubFolderCount()
Sets sub_folder_count
public
setSubFolderCount(string|null $sub_folder_count) : $this
Parameters
- $sub_folder_count : 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> —setType()
Sets type
public
setType(string|null $type) : $this
Parameters
- $type : string|null
Return values
$this —setUri()
Sets uri
public
setUri(string|null $uri) : $this
Parameters
- $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