UpdateUserRequest
in package
implements
JsonSerializable
The `UpdateUserRequest` schema from the server's OpenAPI document.
Every property is optional, so this is a SPARSE body: what you leave unset is left unchanged, and is omitted from the wire request entirely rather than sent as null (§27.4 rule 5).
Table of Contents
Interfaces
- JsonSerializable
Properties
- $email : string|null
- $metadata : mixed
- $status : UserStatus|null
- $username : string|null
Methods
- __construct() : mixed
- Constructs a UpdateUserRequest.
- fromArray() : self
- Rebuilds a UpdateUserRequest from one decoded JSON object.
- jsonSerialize() : array<string, mixed>
- Renders this object for `json_encode()`.
- toArray() : array<string, mixed>
- Renders this object back to its wire form.
Properties
$email read-only
public
string|null
$email
= null
$metadata read-only
public
mixed
$metadata
= null
$status read-only
public
UserStatus|null
$status
= null
$username read-only
public
string|null
$username
= null
Methods
__construct()
Constructs a UpdateUserRequest.
public
__construct([string|null $email = null ][, mixed $metadata = null ][, UserStatus|null $status = null ][, string|null $username = null ]) : mixed
Parameters
- $email : string|null = null
-
the server's
emailfield (optional) - $metadata : mixed = null
-
the server's
metadatafield (optional) - $status : UserStatus|null = null
-
the server's
statusfield (optional) - $username : string|null = null
-
the server's
usernamefield (optional)
fromArray()
Rebuilds a UpdateUserRequest from one decoded JSON object.
public
static fromArray(array<string, mixed> $data) : self
Parameters
- $data : array<string, mixed>
-
The raw wire object.
Return values
selfjsonSerialize()
Renders this object for `json_encode()`.
public
jsonSerialize() : array<string, mixed>
Any Sensitive it carries stays WRAPPED here, so a log line or a
json_encode($model) in application code prints [SENSITIVE]. The one place a secret
is revealed is ManagementTransport, on the way to the wire
and nowhere else (§27.5).
Return values
array<string, mixed>toArray()
Renders this object back to its wire form.
public
toArray() : array<string, mixed>
§27.4 rule 5: a null property is OMITTED, not emitted as null. On a sparse update those two say opposite things — "leave this alone" versus "set this to nothing" — and only omission means the first.