Skip to content

Make new TLD fields nullable as the API doesn't always return them #81

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
koenhendriks wants to merge 2 commits into from
Closed

Make new TLD fields nullable as the API doesn't always return them #81

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5887a68
Add test for `.com` TLD API nullable fields configuration. confirming…
koenhendriks May 4, 2026
91f16a4
Update `TLDMetaData` to allow nullable fields for premium support and…
koenhendriks May 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 13 additions & 10 deletions src/Domain/TLDMetaData.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ final class TLDMetaData implements DomainObjectInterface

public string $gdprCategory;

public string $premiumSupport;
public ?string $premiumSupport;

public DomainSyntax $domainSyntax;

Expand All @@ -94,9 +94,9 @@ final class TLDMetaData implements DomainObjectInterface

public ?LaunchPhaseCollection $launchPhases;

public bool $wdrpNotifications;
public ?bool $wdrpNotifications;

public bool $errpNotifications;
public ?bool $errpNotifications;

public ?int $transferLockDays;

Expand Down Expand Up @@ -139,9 +139,9 @@ private function __construct(
?string $jurisdiction,
?string $termsOfService,
?string $privacyPolicy,
string $premiumSupport,
bool $wdrpNotifications,
bool $errpNotifications,
?string $premiumSupport,
?bool $wdrpNotifications,
?bool $errpNotifications,
?int $transferLockDays
) {
$this->createDomainPeriods = $createDomainPeriods;
Expand Down Expand Up @@ -204,7 +204,10 @@ public static function fromArray(array $json): TLDMetaData
}
WhoisExposureEnum::validate($json['whoisExposure']);
GDPRCategoryEnum::validate($json['gdprCategory']);
PremiumSupportEnum::validate($json['premiumSupport']);

if (isset($json['premiumSupport'])) {
PremiumSupportEnum::validate($json['premiumSupport']);
}

return new TLDMetaData(
$json['createDomainPeriods'],
Expand Down Expand Up @@ -245,9 +248,9 @@ public static function fromArray(array $json): TLDMetaData
$json['jurisdiction'] ?? null,
$json['termsOfService'] ?? null,
$json['privacyPolicy'] ?? null,
$json['premiumSupport'],
$json['wdrpNotifications'],
$json['errpNotifications'],
$json['premiumSupport'] ?? null,
$json['wdrpNotifications'] ?? null,
$json['errpNotifications'] ?? null,
$json['transferLockDays'] ?? null
);
}
Expand Down
16 changes: 16 additions & 0 deletions tests/Clients/Domains/TLDsApiInfoTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,22 @@ public function test_info_com(): void
Assert::assertSame(113, $languageCodes->count());
}

public function test_info_com_nullables(): void
{
$json = file_get_contents(__DIR__ . '/../../Domain/data/tldinfo_com-nullables.json');

assert(is_string($json));

$sdk = MockedClientFactory::makeSdk(
200,
$json,
MockedClientFactory::assertRoute('GET', 'v2/tlds/com/info', $this)
);

$response = $sdk->tlds->info('com');
$this->assertInstanceOf(TLDInfo::class, $response);
}

public function test_info_nl(): void
{
$json = file_get_contents(__DIR__ . '/../../Domain/data/tldinfo_nl.json');
Expand Down
89 changes: 89 additions & 0 deletions tests/Domain/data/tldinfo_com-nullables.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
{
"metadata": {
"renewDomainPeriods": [
12,
24,
36,
48,
60,
72,
84,
96,
108,
120
],
"whoisExposure": "FULL",
"gdprCategory": "UNKNOWN",
"createDomainPeriods": [
12,
24,
36,
48,
60,
72,
84,
96,
108,
120
],
"autoRenewDomainPeriods": [
12
],
"registrant": {
"organizationRequired": false,
"organizationAllowed": true
},
"adjustableAuthCode": true,
"creationRequiresPreValidation": false,
"transferFOA": true,
"featuresAvailable": [
"RESTORE",
"CREATE",
"PRIVACY_PROTECT",
"RENEW",
"TRANSFER",
"UPDATE"
],
"customAuthcodeSupport": true,
"adminContacts": {
"min": 1,
"max": 10,
"required": true,
"organizationRequired": false,
"organizationAllowed": true
},
"billingContacts": {
"min": 0,
"max": 10,
"required": false,
"organizationRequired": false,
"organizationAllowed": true
},
"techContacts": {
"min": 1,
"max": 10,
"required": true,
"organizationRequired": false,
"organizationAllowed": true
},
"nameservers": {
"min": 0,
"max": 10,
"required": false
},
"domainSyntax": {
"minLength": 3,
"maxLength": 63,
"idnType": "UTS46",
"idnSupport": true
},
"transferRequiresAuthcode": true,
"transferSupportsAuthcode": true,
"registrantChangeApprovalRequired": true
},
"provider": "Verisign",
"applicableFor": [
"com",
"net"
]
}