PHP Sigfox Client

DeviceTypesId

Table of Contents

bulkRestart()  : AsyncResponse<DeviceTypesIdBulkRestartResponse, ActionJob>
Restart the devices of a device type with a asynchronous job.
callbacks()  : DeviceTypesIdCallbacks
callbacksNotDelivered()  : PaginateResponse<ErrorMessages, DeviceTypesIdCallbacksNotDeliveredResponse>
Retrieve a list of undelivered callback messages for a given device types. SNR will be deprecated (see [Newsletter](https://backend.sigfox.com/welcome/news) for details). To monitor radio link quality, please use the [Link Quality Indicator (LQI)](https://support.sigfox.com/docs/link-quality:-general-knowledge) which is more relevant than SNR in Sigfox network.
delete()  : void
Delete a given device type.
disengage()  : void
Disable the sequence number check for the next message of each device of a device type.
get()  : DeviceType
Retrieve information about a device type.
messages()  : PaginateResponse<DeviceMessage, DeviceTypesIdMessagesResponse>
Retrieve a list of messages for a given device types. SNR will be deprecated (see [Newsletter](https://backend.sigfox.com/welcome/news) for details). To monitor radio link quality, please use the [Link Quality Indicator (LQI)](https://support.sigfox.com/docs/link-quality:-general-knowledge) which is more relevant than SNR in Sigfox network.
update()  : void
Update a given device type.

Methods

bulkRestart()

Restart the devices of a device type with a asynchronous job.

public bulkRestart() : AsyncResponse<DeviceTypesIdBulkRestartResponse, ActionJob>
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
NotFoundException

If server returned a HTTP 404 error.

throws
InternalServerException

If server returned a HTTP 500 error.

throws
DeserializeException

If failed to deserialize response body as a response object.

Return values
AsyncResponse<DeviceTypesIdBulkRestartResponse, ActionJob>

callbacksNotDelivered()

Retrieve a list of undelivered callback messages for a given device types. SNR will be deprecated (see [Newsletter](https://backend.sigfox.com/welcome/news) for details). To monitor radio link quality, please use the [Link Quality Indicator (LQI)](https://support.sigfox.com/docs/link-quality:-general-knowledge) which is more relevant than SNR in Sigfox network.

public callbacksNotDelivered([DeviceTypesIdCallbacksNotDelivered|array<string|int, mixed>|null $request = null ]) : PaginateResponse<ErrorMessages, DeviceTypesIdCallbacksNotDeliveredResponse>
Parameters
$request : DeviceTypesIdCallbacksNotDelivered|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
NotFoundException

If server returned a HTTP 404 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<ErrorMessages, DeviceTypesIdCallbacksNotDeliveredResponse>

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

delete()

Delete a given device type.

public delete() : void
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
NotFoundException

If server returned a HTTP 404 error.

throws
InternalServerException

If server returned a HTTP 500 error.

Return values
void

disengage()

Disable the sequence number check for the next message of each device of a device type.

public disengage() : void
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
NotFoundException

If server returned a HTTP 404 error.

throws
InternalServerException

If server returned a HTTP 500 error.

Return values
void

get()

Retrieve information about a device type.

public get([DeviceTypesIdGet|array<string|int, mixed>|null $request = null ]) : DeviceType
Parameters
$request : DeviceTypesIdGet|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
NotFoundException

If server returned a HTTP 404 error.

throws
InternalServerException

If server returned a HTTP 500 error.

throws
DeserializeException

If failed to deserialize response body as a response object.

Return values
DeviceType

messages()

Retrieve a list of messages for a given device types. SNR will be deprecated (see [Newsletter](https://backend.sigfox.com/welcome/news) for details). To monitor radio link quality, please use the [Link Quality Indicator (LQI)](https://support.sigfox.com/docs/link-quality:-general-knowledge) which is more relevant than SNR in Sigfox network.

public messages([DeviceTypesIdMessages|array<string|int, mixed>|null $request = null ]) : PaginateResponse<DeviceMessage, DeviceTypesIdMessagesResponse>
Parameters
$request : DeviceTypesIdMessages|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
NotFoundException

If server returned a HTTP 404 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<DeviceMessage, DeviceTypesIdMessagesResponse>

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

update()

Update a given device type.

public update(DeviceTypeUpdate|array<string|int, mixed>|null $deviceType) : void
Parameters
$deviceType : DeviceTypeUpdate|array<string|int, mixed>|null

The device type to update

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
NotFoundException

If server returned a HTTP 404 error.

throws
InternalServerException

If server returned a HTTP 500 error.

Return values
void

Search results