UserBlocks
extends ManagementEndpoint
in package
implements
UserBlocksInterface
Class UserBlocks.
Handles requests to the User Blocks endpoint of the v2 Management API.
Tags
Interfaces, Classes, Traits and Enums
- UserBlocksInterface
- Interface UserBlocksInterface.
Table of Contents
- $httpClient : HttpClient
- __construct() : mixed
- ManagementEndpoint constructor.
- delete() : ResponseInterface
- Unblock a user that was blocked due to an excessive amount of incorrectly provided credentials.
- deleteByIdentifier() : ResponseInterface
- Unblock a user blocked due to an excessive amount of incorrectly-provided credentials.
- get() : ResponseInterface
- Retrieve a list of blocked IP addresses for the login identifiers (email, username, phone number, etc) associated with the specified user.
- getByIdentifier() : ResponseInterface
- Retrieve a list of blocked IP addresses for a given identifier (e.g., username, phone number or email).
- 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.
- instance() : static
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 —delete()
Unblock a user that was blocked due to an excessive amount of incorrectly provided credentials.
public
delete(string $id[, RequestOptions|null $options = null ]) : ResponseInterface
Required scope: update:users.
Parameters
- $id : string
-
the user_id of the user to update
- $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 —deleteByIdentifier()
Unblock a user blocked due to an excessive amount of incorrectly-provided credentials.
public
deleteByIdentifier(string $identifier[, RequestOptions|null $options = null ]) : ResponseInterface
Required scope: update:users.
Parameters
- $identifier : string
-
should be any of a username, phone number, or email
- $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 —get()
Retrieve a list of blocked IP addresses for the login identifiers (email, username, phone number, etc) associated with the specified user.
public
get(string $id[, RequestOptions|null $options = null ]) : ResponseInterface
Required scope: read:users.
Parameters
- $id : string
-
user ID to query for
- $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 —getByIdentifier()
Retrieve a list of blocked IP addresses for a given identifier (e.g., username, phone number or email).
public
getByIdentifier(string $identifier[, RequestOptions|null $options = null ]) : ResponseInterface
Required scope: read:users.
Parameters
- $identifier : string
-
should be any of a username, phone number, or email
- $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 —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 —instance()
public
static instance(HttpClient $httpClient) : static
Parameters
- $httpClient : HttpClient