PHP Sigfox Client

ApiUsers

Table of Contents

create()  : string
Create a new API user.
find()  : ApiUsersId
Find by id
list()  : PaginateResponse<ApiUser, ApiUsersListResponse>
Retrieve a list of API users according to visibility permissions and request filters.

Methods

create()

Create a new API user.

public create(ApiUserCreation|array<string|int, mixed>|null $apiUser) : string
Parameters
$apiUser : ApiUserCreation|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
MethodNotAllowedException

If server returned a HTTP 405 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 newly created API user identifier

list()

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

public list([ApiUsersList|array<string|int, mixed>|null $request = null ]) : PaginateResponse<ApiUser, ApiUsersListResponse>
Parameters
$request : ApiUsersList|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
MethodNotAllowedException

If server returned a HTTP 405 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<ApiUser, ApiUsersListResponse>

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

Search results