PHP Sigfox Client

Groups

Table of Contents

create()  : string
Create a new group.
find()  : GroupsId
Find by id
list()  : PaginateResponse<Group, GroupsListResponse>
Retrieve a list of groups according to visibility permissions and request filters.

Methods

create()

Create a new group.

public create(CommonGroupCreate|array<string|int, mixed>|null $group) : string
Parameters
$group : CommonGroupCreate|array<string|int, mixed>|null
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
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 new created group identifier

find()

Find by id

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

The Group identifier

Return values
GroupsId

list()

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

public list([GroupsList|array<string|int, mixed>|null $request = null ]) : PaginateResponse<Group, GroupsListResponse>

If parentIds is provided, retrieve all direct sub-groups under the given parents. If parentIds is not provided, retrieve all direct sub-groups under the API user's group. If deep is true, retrieve all sub-groups under either given parent groups or the API user group.

Parameters
$request : GroupsList|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<Group, GroupsListResponse>

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

Search results