Tenants
extends ManagementEndpoint
in package
implements
TenantsInterface
Class Tenants.
Handles requests to the Tenants endpoint of the v2 Management API.
Tags
Interfaces, Classes, Traits and Enums
- TenantsInterface
- Interface TenantsInterface.
Table of Contents
- $httpClient : HttpClient
- __construct() : mixed
- ManagementEndpoint constructor.
- getHttpClient() : HttpClient
- Get the injected HttpClient instance.
- getLastRequest() : HttpRequest|null
- Return an instance of HttpRequest representing the last issued request.
- getResponsePaginator() : HttpResponsePaginator
- Return a ResponsePaginator instance configured for the last HttpRequest.
- getSettings() : ResponseInterface
- Return all tenant settings.
- instance() : static
- updateSettings() : ResponseInterface
- Update tenant settings.
Properties
$httpClient
private
HttpClient
$httpClient
Methods
__construct()
ManagementEndpoint constructor.
public
final __construct(HttpClient $httpClient) : mixed
Parameters
- $httpClient : HttpClient
-
httpClient instance to use
Return values
mixed —getHttpClient()
Get the injected HttpClient instance.
public
final getHttpClient() : HttpClient
Return values
HttpClient —getLastRequest()
Return an instance of HttpRequest representing the last issued request.
public
final getLastRequest() : HttpRequest|null
Return values
HttpRequest|null —getResponsePaginator()
Return a ResponsePaginator instance configured for the last HttpRequest.
public
final getResponsePaginator() : HttpResponsePaginator
Return values
HttpResponsePaginator —getSettings()
Return all tenant settings.
public
getSettings([RequestOptions|null $options = null ]) : ResponseInterface
Required scope: read:tenant_settings.
Parameters
- $options : RequestOptions|null = null
-
Optional. Additional request options to use, such as a field filtering or pagination. (Not all endpoints support these. See @see for supported options.)
Return values
ResponseInterface —instance()
public
static instance(HttpClient $httpClient) : static
Parameters
- $httpClient : HttpClient
Return values
static —updateSettings()
Update tenant settings.
public
updateSettings(array<string|int, mixed> $body[, RequestOptions|null $options = null ]) : ResponseInterface
Required scope: update:tenant_settings.
Parameters
- $body : array<string|int, mixed>
-
Updated settings to send to the API. See @see for supported options.
- $options : RequestOptions|null = null
-
Optional. Additional request options to use, such as a field filtering or pagination. (Not all endpoints support these. See @see for supported options.)