PHP Sigfox Client

Devices

Table of Contents

bulk()  : DevicesBulk
create()  : string
Create a new device.
find()  : DevicesId
Find by id
list()  : PaginateResponse<Device, DevicesListResponse>
Retrieve a list of devices according to visibility permissions and request filters.

Methods

create()

Create a new device.

public create(DeviceCreationJob|array<string|int, mixed>|null $device) : string
Parameters
$device : DeviceCreationJob|array<string|int, mixed>|null

The device to create

Tags
throws
SerializeException

If request object failed to serialize to a JSON serializable type.

throws
UnexpectedResponseException

If server returned an unexpected status code.

throws
ResponseException

If server returned any expected HTTP error

throws
ValidationException

If request could not be validated according to pre validation rules.

throws
BadRequestException

If server returned a HTTP 400 error.

throws
UnauthorizedException

If server returned a HTTP 401 error.

throws
ForbiddenException

If server returned a HTTP 403 error.

throws
ConflictException

If server returned a HTTP 409 error.

throws
InternalServerException

If server returned a HTTP 500 error.

throws
DeserializeException

If failed to deserialize response body as a response object.

Return values
string

The device's identifier (hexadecimal format)

find()

Find by id

public find(string $id) : DevicesId
Parameters
$id : string

The Device identifier (hexadecimal format)

Return values
DevicesId

list()

Retrieve a list of devices according to visibility permissions and request filters.

public list([DevicesList|array<string|int, mixed>|null $request = null ]) : PaginateResponse<Device, DevicesListResponse>
Parameters
$request : DevicesList|array<string|int, mixed>|null = null

The query and body parameters to pass

Tags
throws
SerializeException

If request object failed to serialize to a JSON serializable type.

throws
UnexpectedResponseException

If server returned an unexpected status code.

throws
ResponseException

If server returned any expected HTTP error

throws
ValidationException

If request could not be validated according to pre validation rules.

throws
BadRequestException

If server returned a HTTP 400 error.

throws
UnauthorizedException

If server returned a HTTP 401 error.

throws
ForbiddenException

If server returned a HTTP 403 error.

throws
InternalServerException

If server returned a HTTP 500 error.

throws
DeserializeException

If failed to deserialize response body as a response object.

Return values
PaginateResponse<Device, DevicesListResponse>

First generic parameter is the item type and the second type is the original response type.

Search results