Filter
in package
implements
ModelInterface, ArrayAccess
Filter 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
- getActionRequired() : string|null
- Gets action_required
- getExpires() : string|null
- Gets expires
- getFolderIds() : string|null
- Gets folder_ids
- getFromDateTime() : string|null
- Gets from_date_time
- getIsTemplate() : string|null
- Gets is_template
- getModelName() : string
- The original name of the model.
- getOrder() : string|null
- Gets order
- getOrderBy() : string|null
- Gets order_by
- getSearchTarget() : string|null
- Gets search_target
- getSearchText() : string|null
- Gets search_text
- getStatus() : string|null
- Gets status
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getToDateTime() : string|null
- Gets to_date_time
- 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.
- setActionRequired() : $this
- Sets action_required
- setExpires() : $this
- Sets expires
- setFolderIds() : $this
- Sets folder_ids
- setFromDateTime() : $this
- Sets from_date_time
- setIsTemplate() : $this
- Sets is_template
- setOrder() : $this
- Sets order
- setOrderBy() : $this
- Sets order_by
- setSearchTarget() : $this
- Sets search_target
- setSearchText() : $this
- Sets search_text
- setStatus() : $this
- Sets status
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setToDateTime() : $this
- Sets to_date_time
- 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
= ['action_required' => 'actionRequired', 'expires' => 'expires', 'folder_ids' => 'folderIds', 'from_date_time' => 'fromDateTime', 'is_template' => 'isTemplate', 'order' => 'order', 'order_by' => 'orderBy', 'search_target' => 'searchTarget', 'search_text' => 'searchText', 'status' => 'status', 'to_date_time' => 'toDateTime']
$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
= ['action_required' => 'getActionRequired', 'expires' => 'getExpires', 'folder_ids' => 'getFolderIds', 'from_date_time' => 'getFromDateTime', 'is_template' => 'getIsTemplate', 'order' => 'getOrder', 'order_by' => 'getOrderBy', 'search_target' => 'getSearchTarget', 'search_text' => 'getSearchText', 'status' => 'getStatus', 'to_date_time' => 'getToDateTime']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['action_required' => 'setActionRequired', 'expires' => 'setExpires', 'folder_ids' => 'setFolderIds', 'from_date_time' => 'setFromDateTime', 'is_template' => 'setIsTemplate', 'order' => 'setOrder', 'order_by' => 'setOrderBy', 'search_target' => 'setSearchTarget', 'search_text' => 'setSearchText', 'status' => 'setStatus', 'to_date_time' => 'setToDateTime']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['action_required' => null, 'expires' => null, 'folder_ids' => null, 'from_date_time' => null, 'is_template' => null, 'order' => null, 'order_by' => null, 'search_target' => null, 'search_text' => null, 'status' => null, 'to_date_time' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'filter'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['action_required' => '?string', 'expires' => '?string', 'folder_ids' => '?string', 'from_date_time' => '?string', 'is_template' => '?string', 'order' => '?string', 'order_by' => '?string', 'search_target' => '?string', 'search_text' => '?string', 'status' => '?string', 'to_date_time' => '?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> —getActionRequired()
Gets action_required
public
getActionRequired() : string|null
Return values
string|null —getExpires()
Gets expires
public
getExpires() : string|null
Return values
string|null —getFolderIds()
Gets folder_ids
public
getFolderIds() : string|null
Return values
string|null —getFromDateTime()
Gets from_date_time
public
getFromDateTime() : string|null
Return values
string|null —getIsTemplate()
Gets is_template
public
getIsTemplate() : string|null
Return values
string|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getOrder()
Gets order
public
getOrder() : string|null
Return values
string|null —getOrderBy()
Gets order_by
public
getOrderBy() : string|null
Return values
string|null —getSearchTarget()
Gets search_target
public
getSearchTarget() : string|null
Return values
string|null —getSearchText()
Gets search_text
public
getSearchText() : string|null
Return values
string|null —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> —getToDateTime()
Gets to_date_time
public
getToDateTime() : 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 —setActionRequired()
Sets action_required
public
setActionRequired(string|null $action_required) : $this
Parameters
- $action_required : string|null
-
Access token information.
Return values
$this —setExpires()
Sets expires
public
setExpires(string|null $expires) : $this
Parameters
- $expires : string|null
Return values
$this —setFolderIds()
Sets folder_ids
public
setFolderIds(string|null $folder_ids) : $this
Parameters
- $folder_ids : string|null
Return values
$this —setFromDateTime()
Sets from_date_time
public
setFromDateTime(string|null $from_date_time) : $this
Parameters
- $from_date_time : string|null
Return values
$this —setIsTemplate()
Sets is_template
public
setIsTemplate(string|null $is_template) : $this
Parameters
- $is_template : string|null
Return values
$this —setOrder()
Sets order
public
setOrder(string|null $order) : $this
Parameters
- $order : string|null
Return values
$this —setOrderBy()
Sets order_by
public
setOrderBy(string|null $order_by) : $this
Parameters
- $order_by : string|null
Return values
$this —setSearchTarget()
Sets search_target
public
setSearchTarget(string|null $search_target) : $this
Parameters
- $search_target : string|null
Return values
$this —setSearchText()
Sets search_text
public
setSearchText(string|null $search_text) : $this
Parameters
- $search_text : 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> —setToDateTime()
Sets to_date_time
public
setToDateTime(string|null $to_date_time) : $this
Parameters
- $to_date_time : string|null
-
Must be set to "bearer".
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