ContractInfosIdDevices extends Request
Retrieve a list of devices according to visibility permissions and request filters.
Table of Contents
- $deviceTypeId : string|null
- Returns only devices of the given device type
- $fields : string|null
- Defines the other available fields to be returned in the response.
- $limit : int|null
- The maximum number of items to return
- $pageId : string|null
- Token representing the page to retrieve
- from() : static
- Initializing a model from an array
- jsonSerialize() : array<string|int, mixed>
- setDeviceTypeId() : static
- Setter for deviceTypeId
- setFields() : static
- Setter for fields
- setLimit() : static
- Setter for limit
- setPageId() : static
- Setter for pageId
Properties
$deviceTypeId
Returns only devices of the given device type
protected
string|null
$deviceTypeId
= null
$fields
Defines the other available fields to be returned in the response.
protected
string|null
$fields
= null
$limit
The maximum number of items to return
protected
int|null
$limit
= null
$pageId
Token representing the page to retrieve
protected
string|null
$pageId
= null
Methods
from()
Initializing a model from an array
public
static from(array<string|int, mixed> $params) : static
Parameters
- $params : array<string|int, mixed>
-
Pass this parameter if you want to initial property value from an array. See API reference for all property names and types
Tags
Return values
static —jsonSerialize()
public
jsonSerialize() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —setDeviceTypeId()
Setter for deviceTypeId
public
setDeviceTypeId(string $deviceTypeId) : static
Parameters
- $deviceTypeId : string
-
Returns only devices of the given device type
Return values
static —To use in method chains
setFields()
Setter for fields
public
setFields(string $fields) : static
Parameters
- $fields : string
-
Defines the other available fields to be returned in the response.
Return values
static —To use in method chains
setLimit()
Setter for limit
public
setLimit(int $limit) : static
Parameters
- $limit : int
-
The maximum number of items to return
Return values
static —To use in method chains
setPageId()
Setter for pageId
public
setPageId(string $pageId) : static
Parameters
- $pageId : string
-
Token representing the page to retrieve
Return values
static —To use in method chains