FolderItemResponse
in package
implements
ModelInterface, ArrayAccess
FolderItemResponse 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
- getEndPosition() : string|null
- Gets end_position
- getFolderItems() : array<string|int, FolderItemV2>
- Gets folder_items
- getModelName() : string
- The original name of the model.
- getNextUri() : string|null
- Gets next_uri
- getPreviousUri() : string|null
- Gets previous_uri
- getResultSetSize() : string|null
- Gets result_set_size
- getStartPosition() : string|null
- Gets start_position
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getTotalRows() : string|null
- Gets total_rows
- 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.
- setEndPosition() : $this
- Sets end_position
- setFolderItems() : $this
- Sets folder_items
- setNextUri() : $this
- Sets next_uri
- setPreviousUri() : $this
- Sets previous_uri
- setResultSetSize() : $this
- Sets result_set_size
- setStartPosition() : $this
- Sets start_position
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setTotalRows() : $this
- Sets total_rows
- 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
= ['end_position' => 'endPosition', 'folder_items' => 'folderItems', 'next_uri' => 'nextUri', 'previous_uri' => 'previousUri', 'result_set_size' => 'resultSetSize', 'start_position' => 'startPosition', 'total_rows' => 'totalRows']
$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
= ['end_position' => 'getEndPosition', 'folder_items' => 'getFolderItems', 'next_uri' => 'getNextUri', 'previous_uri' => 'getPreviousUri', 'result_set_size' => 'getResultSetSize', 'start_position' => 'getStartPosition', 'total_rows' => 'getTotalRows']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['end_position' => 'setEndPosition', 'folder_items' => 'setFolderItems', 'next_uri' => 'setNextUri', 'previous_uri' => 'setPreviousUri', 'result_set_size' => 'setResultSetSize', 'start_position' => 'setStartPosition', 'total_rows' => 'setTotalRows']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['end_position' => null, 'folder_items' => null, 'next_uri' => null, 'previous_uri' => null, 'result_set_size' => null, 'start_position' => null, 'total_rows' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'folderItemResponse'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['end_position' => '?string', 'folder_items' => '\\DocuSign\\eSign\\Model\\FolderItemV2[]', 'next_uri' => '?string', 'previous_uri' => '?string', 'result_set_size' => '?string', 'start_position' => '?string', 'total_rows' => '?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> —getEndPosition()
Gets end_position
public
getEndPosition() : string|null
Return values
string|null —getFolderItems()
Gets folder_items
public
getFolderItems() : array<string|int, FolderItemV2>
Return values
array<string|int, FolderItemV2> —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getNextUri()
Gets next_uri
public
getNextUri() : string|null
Return values
string|null —getPreviousUri()
Gets previous_uri
public
getPreviousUri() : string|null
Return values
string|null —getResultSetSize()
Gets result_set_size
public
getResultSetSize() : string|null
Return values
string|null —getStartPosition()
Gets start_position
public
getStartPosition() : 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> —getTotalRows()
Gets total_rows
public
getTotalRows() : 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 —setEndPosition()
Sets end_position
public
setEndPosition(string|null $end_position) : $this
Parameters
- $end_position : string|null
-
The last position in the result set.
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 —setNextUri()
Sets next_uri
public
setNextUri(string|null $next_uri) : $this
Parameters
- $next_uri : string|null
-
The URI to the next chunk of records based on the search request. If the endPosition is the entire results of the search, this is null.
Return values
$this —setPreviousUri()
Sets previous_uri
public
setPreviousUri(string|null $previous_uri) : $this
Parameters
- $previous_uri : string|null
-
The postal code for the billing address.
Return values
$this —setResultSetSize()
Sets result_set_size
public
setResultSetSize(string|null $result_set_size) : $this
Parameters
- $result_set_size : string|null
-
The number of results returned in this response.
Return values
$this —setStartPosition()
Sets start_position
public
setStartPosition(string|null $start_position) : $this
Parameters
- $start_position : string|null
-
Starting position of the current result set.
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> —setTotalRows()
Sets total_rows
public
setTotalRows(string|null $total_rows) : $this
Parameters
- $total_rows : 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