ApiProviderConfig
in package
implements
JsonSerializable
API-based provider configuration (SendGrid, Postmark, Resend, Brevo). `api_key` follows the same write-only + omit-preserving contract as [`SmtpConfig::password`] (D-01/D-02).
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
- $apiUrl : string|null
Methods
- __construct() : mixed
- Constructs a ApiProviderConfig.
- fromArray() : self
- Rebuilds a ApiProviderConfig 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
$apiUrl read-only
public
string|null
$apiUrl
= null
Methods
__construct()
Constructs a ApiProviderConfig.
public
__construct([string|null $apiUrl = null ]) : mixed
Parameters
- $apiUrl : string|null = null
-
Override base URL (useful for testing / self-hosted instances). (optional)
fromArray()
Rebuilds a ApiProviderConfig 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.