PHP Sigfox Client

Users

Table of Contents

create()  : CreateResponse
Create a new user.
find()  : UsersId
Find by id
list()  : PaginateResponse<User, UsersListResponse>
Retrieve a list of users according to visibility permissions and request filters.

Methods

create()

Create a new user.

public create(UserCreation|array<string|int, mixed>|null $user) : CreateResponse
Parameters
$user : UserCreation|array<string|int, mixed>|null

The user 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
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
CreateResponse

find()

Find by id

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

The User identifier

Return values
UsersId

list()

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

public list([UsersList|array<string|int, mixed>|null $request = null ]) : PaginateResponse<User, UsersListResponse>
Parameters
$request : UsersList|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<User, UsersListResponse>

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

Search results