PHP Sigfox Client

DevicesBulk

Table of Contents

create()  : AsyncResponse<DevicesBulkCreateResponse, RegistrationJobStatus>
Create multiple new devices with asynchronous job
replace()  : ReplaceResponse
Replace multiple devices (moving tokens from one device to another) with synchronous job
restart()  : AsyncResponse<DevicesBulkRestartResponse, ActionJob>
Restart multiple devices with asynchronous job.
resume()  : AsyncResponse<DevicesBulkResumeResponse, ActionJob>
Resume multiple devices with asynchronous job.
suspend()  : AsyncResponse<DevicesBulkSuspendResponse, ActionJob>
Suspend multiple devices with asynchronous job
transfer()  : AsyncResponse<DevicesBulkTransferResponse, RegistrationJobStatus>
Transfer multiple devices to another device type with asynchronous job
unsubscribe()  : AsyncResponse<DevicesBulkUnsubscribeResponse, ActionJob>
Unsubscribe multiple devices with asynchronous job.
update()  : AsyncResponse<DevicesBulkUpdateResponse, RegistrationJobStatus>
Update or edit multiple devices with asynchronous job.

Methods

create()

Create multiple new devices with asynchronous job

public create(AsynchronousDeviceCreationJob|array<string|int, mixed>|null $devices) : AsyncResponse<DevicesBulkCreateResponse, RegistrationJobStatus>
Parameters
$devices : AsynchronousDeviceCreationJob|array<string|int, mixed>|null

The devices 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
AsyncResponse<DevicesBulkCreateResponse, RegistrationJobStatus>

replace()

Replace multiple devices (moving tokens from one device to another) with synchronous job

public replace(AsynchronousDeviceReplacementJob|array<string|int, mixed>|null $devicePairs) : ReplaceResponse
Parameters
$devicePairs : AsynchronousDeviceReplacementJob|array<string|int, mixed>|null

Pairs of source and target devices

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
ReplaceResponse

restart()

Restart multiple devices with asynchronous job.

public restart([DevicesBulkRestart|array<string|int, mixed>|null $request = null ]) : AsyncResponse<DevicesBulkRestartResponse, ActionJob>
Parameters
$request : DevicesBulkRestart|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
AsyncResponse<DevicesBulkRestartResponse, ActionJob>

resume()

Resume multiple devices with asynchronous job.

public resume([DevicesBulkResume|array<string|int, mixed>|null $request = null ]) : AsyncResponse<DevicesBulkResumeResponse, ActionJob>
Parameters
$request : DevicesBulkResume|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
AsyncResponse<DevicesBulkResumeResponse, ActionJob>

suspend()

Suspend multiple devices with asynchronous job

public suspend([DevicesBulkSuspend|array<string|int, mixed>|null $request = null ]) : AsyncResponse<DevicesBulkSuspendResponse, ActionJob>
Parameters
$request : DevicesBulkSuspend|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
AsyncResponse<DevicesBulkSuspendResponse, ActionJob>

transfer()

Transfer multiple devices to another device type with asynchronous job

public transfer(AsynchronousDeviceTransferJob|array<string|int, mixed>|null $devices) : AsyncResponse<DevicesBulkTransferResponse, RegistrationJobStatus>
Parameters
$devices : AsynchronousDeviceTransferJob|array<string|int, mixed>|null

The devices to move

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
AsyncResponse<DevicesBulkTransferResponse, RegistrationJobStatus>

unsubscribe()

Unsubscribe multiple devices with asynchronous job.

public unsubscribe([DevicesBulkUnsubscribe|array<string|int, mixed>|null $request = null ]) : AsyncResponse<DevicesBulkUnsubscribeResponse, ActionJob>
Parameters
$request : DevicesBulkUnsubscribe|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
AsyncResponse<DevicesBulkUnsubscribeResponse, ActionJob>

update()

Update or edit multiple devices with asynchronous job.

public update([DevicesBulkUpdate|array<string|int, mixed>|null $request = null ]) : AsyncResponse<DevicesBulkUpdateResponse, RegistrationJobStatus>
Parameters
$request : DevicesBulkUpdate|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
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
AsyncResponse<DevicesBulkUpdateResponse, RegistrationJobStatus>

Search results