some cleanup

dcarbone · dcarbone · commit ec161b424502 · 2025-04-14T21:57:18.000-05:00
diff --git a/src/ACL/ACLAuthMethodListEntryQueryResponse.php b/src/ACL/ACLAuthMethodListEntryQueryResponse.php
@@ -25,6 +25,7 @@
 
 class ACLAuthMethodListEntryQueryResponse extends AbstractValuedQueryResponse implements UnmarshalledResponseInterface
 {
+    /** @var \DCarbone\PHPConsulAPI\ACL\ACLAuthMethodListEntry[] */
     public array $ACLAuthMethodListEntries = [];
 
     public function getValue(): array
diff --git a/src/ACL/ACLBindingRulesQueryResponse.php b/src/ACL/ACLBindingRulesQueryResponse.php
@@ -25,6 +25,7 @@
 
 class ACLBindingRulesQueryResponse extends AbstractValuedQueryResponse implements UnmarshalledResponseInterface
 {
+    /** @var \DCarbone\PHPConsulAPI\ACL\ACLBindingRule[] */
     public array $ACLBindingRules = [];
 
     public function getValue(): array
diff --git a/src/ACL/ACLEntriesResponse.php b/src/ACL/ACLEntriesResponse.php
@@ -25,6 +25,7 @@
 
 class ACLEntriesResponse extends AbstractValuedQueryResponse implements UnmarshalledResponseInterface
 {
+    /** @var \DCarbone\PHPConsulAPI\ACL\ACLEntry[] */
     public array $ACLEntries = [];
 
     public function getValue(): array
diff --git a/src/ACL/ACLPolicy.php b/src/ACL/ACLPolicy.php
@@ -28,6 +28,7 @@ class ACLPolicy extends AbstractModel
     public string $Name;
     public string $Description;
     public string $Rules;
+    /** @var string[] */
     public array $Datacenters;
     public string $Hash;
     public int $CreateIndex;
@@ -108,6 +109,9 @@ public function setRules(string $Rules): self
         return $this;
     }
 
+    /**
+     * @return string[]
+     */
     public function getDatacenters(): array
     {
         return $this->Datacenters;
diff --git a/src/ACL/ACLPolicyListEntryQueryResponse.php b/src/ACL/ACLPolicyListEntryQueryResponse.php
@@ -25,6 +25,7 @@
 
 class ACLPolicyListEntryQueryResponse extends AbstractValuedQueryResponse implements UnmarshalledResponseInterface
 {
+    /** @var \DCarbone\PHPConsulAPI\ACL\ACLPolicyListEntry[] */
     public array $ACLPolicyListEntries = [];
 
     public function getValue(): array
diff --git a/src/ACL/ACLRolesQueryResponse.php b/src/ACL/ACLRolesQueryResponse.php
@@ -25,6 +25,7 @@
 
 class ACLRolesQueryResponse extends AbstractValuedQueryResponse implements UnmarshalledResponseInterface
 {
+    /** @var \DCarbone\PHPConsulAPI\ACL\ACLRole[] */
     public array $ACLRoles = [];
 
     public function getValue(): array
diff --git a/src/ACL/ACLServiceIdentity.php b/src/ACL/ACLServiceIdentity.php
@@ -25,6 +25,7 @@
 class ACLServiceIdentity extends AbstractModel
 {
     public string $ServiceName;
+    /** @var string[] */
     public array $Datacenters;
 
     public function __construct(
@@ -44,6 +45,9 @@ public function getServiceName(): string
         return $this->ServiceName;
     }
 
+    /**
+     * @return string[]
+     */
     public function getDatacenters(): array
     {
         return $this->Datacenters;
diff --git a/src/ACL/ACLTemplatedPolicy.php b/src/ACL/ACLTemplatedPolicy.php
@@ -26,6 +26,7 @@ class ACLTemplatedPolicy extends AbstractModel
 {
     public string $TemplateName;
     public null|ACLTemplatedPolicyVariables $TemplateVariables;
+    /** @var string[] */
     public array $Datacenters;
 
     public function __construct(
@@ -60,6 +61,9 @@ public function setTemplateVariables(null|ACLTemplatedPolicyVariables $TemplateV
         return $this;
     }
 
+    /**
+     * @return string[]
+     */
     public function getDatacenters(): array
     {
         return $this->Datacenters;
diff --git a/src/ACL/ACLTokenExpanded.php b/src/ACL/ACLTokenExpanded.php
@@ -100,6 +100,9 @@ public function __construct(
         }
     }
 
+    /**
+     * @return \DCarbone\PHPConsulAPI\ACL\ACLPolicy[]
+     */
     public function getExpandedPolicies(): array
     {
         return $this->ExpandedPolicies;
@@ -111,6 +114,9 @@ public function setExpandedPolicies(ACLPolicy ...$ExpandedPolicies): self
         return $this;
     }
 
+    /**
+     * @return \DCarbone\PHPConsulAPI\ACL\ACLRole[]
+     */
     public function getExpandedRoles(): array
     {
         return $this->ExpandedRoles;
@@ -122,6 +128,9 @@ public function setExpandedRoles(ACLRole ...$ExpandedRoles): self
         return $this;
     }
 
+    /**
+     * @return string[]
+     */
     public function getNamespaceDefaultPolicyIDs(): array
     {
         return $this->NamespaceDefaultPolicyIDs;
@@ -133,6 +142,9 @@ public function setNamespaceDefaultPolicyIDs(string ...$NamespaceDefaultPolicyID
         return $this;
     }
 
+    /**
+     * @return string[]
+     */
     public function getNamespaceDefaultRoleIDs(): array
     {
         return $this->NamespaceDefaultRoleIDs;
diff --git a/src/ACL/ACLTokenFields.php b/src/ACL/ACLTokenFields.php
@@ -106,6 +106,9 @@ public function setDescription(string $Description): self
         return $this;
     }
 
+    /**
+     * @return \DCarbone\PHPConsulAPI\ACL\ACLTokenPolicyLink[]
+     */
     public function getPolicies(): array
     {
         return $this->Policies;
@@ -117,6 +120,9 @@ public function setPolicies(ACLTokenPolicyLink ...$Policies): self
         return $this;
     }
 
+    /**
+     * @return \DCarbone\PHPConsulAPI\ACL\ACLTokenRoleLink[]
+     */
     public function getRoles(): array
     {
         return $this->Roles;
@@ -128,6 +134,9 @@ public function setRoles(ACLTokenRoleLink ...$Roles): self
         return $this;
     }
 
+    /**
+     * @return \DCarbone\PHPConsulAPI\ACL\ACLServiceIdentity[]
+     */
     public function getServiceIdentities(): array
     {
         return $this->ServiceIdentities;
@@ -139,6 +148,9 @@ public function setServiceIdentities(ACLServiceIdentity ...$ServiceIdentities):
         return $this;
     }
 
+    /**
+     * @return \DCarbone\PHPConsulAPI\ACL\ACLNodeIdentity[]
+     */
     public function getNodeIdentities(): array
     {
         return $this->NodeIdentities;
@@ -150,6 +162,9 @@ public function setNodeIdentities(ACLNodeIdentity ...$NodeIdentities): self
         return $this;
     }
 
+    /**
+     * @return \DCarbone\PHPConsulAPI\ACL\ACLTemplatedPolicy[]
+     */
     public function getTemplatePolicies(): array
     {
         return $this->TemplatePolicies;
diff --git a/src/ACL/ACLTokenListEntry.php b/src/ACL/ACLTokenListEntry.php
@@ -30,10 +30,15 @@ class ACLTokenListEntry extends AbstractModel
     public string $AccessorID;
     public string $SecretID;
     public string $Description;
+    /** @var \DCarbone\PHPConsulAPI\ACL\ACLTokenPolicyLink[] */
     public array $Policies;
+    /** @var \DCarbone\PHPConsulAPI\ACL\ACLRolePolicyLink[] */
     public array $Roles;
+    /** @var \DCarbone\PHPConsulAPI\ACL\ACLServiceIdentity[] */
     public array $ServiceIdentities;
+    /** @var \DCarbone\PHPConsulAPI\ACL\ACLNodeIdentity[] */
     public array $NodeIdentities;
+    /** @var \DCarbone\PHPConsulAPI\ACL\ACLTemplatedPolicy[] */
     public array $TemplatedPolicies;
     public bool $Local;
     public string $AuthMethod;
@@ -146,6 +151,9 @@ public function setDescription(string $Description): self
         return $this;
     }
 
+    /**
+     * @return \DCarbone\PHPConsulAPI\ACL\ACLTokenPolicyLink[]
+     */
     public function getPolicies(): array
     {
         return $this->Policies;
@@ -157,6 +165,9 @@ public function setPolicies(ACLTokenPolicyLink ...$Policies): self
         return $this;
     }
 
+    /**
+     * @return \DCarbone\PHPConsulAPI\ACL\ACLRolePolicyLink[]
+     */
     public function getRoles(): array
     {
         return $this->Roles;
@@ -168,6 +179,9 @@ public function setRoles(ACLTokenRoleLink ...$Roles): self
         return $this;
     }
 
+    /**
+     * @return \DCarbone\PHPConsulAPI\ACL\ACLServiceIdentity[]
+     */
     public function getServiceIdentities(): array
     {
         return $this->ServiceIdentities;
@@ -179,6 +193,9 @@ public function setServiceIdentities(ACLServiceIdentity ...$ServiceIdentities):
         return $this;
     }
 
+    /**
+     * @return \DCarbone\PHPConsulAPI\ACL\ACLNodeIdentity[]
+     */
     public function getNodeIdentities(): array
     {
         return $this->NodeIdentities;
@@ -190,6 +207,9 @@ public function setNodeIdentities(ACLNodeIdentity ...$NodeIdentities): self
         return $this;
     }
 
+    /**
+     * @return \DCarbone\PHPConsulAPI\ACL\ACLTemplatedPolicy[]
+     */
     public function getTemplatedPolicies(): array
     {
         return $this->TemplatedPolicies;
diff --git a/src/ACL/ACLTokenListEntryQueryResponse.php b/src/ACL/ACLTokenListEntryQueryResponse.php
@@ -25,6 +25,7 @@
 
 class ACLTokenListEntryQueryResponse extends AbstractValuedQueryResponse implements UnmarshalledResponseInterface
 {
+    /** @var \DCarbone\PHPConsulAPI\ACL\ACLTokenListEntry[] */
     public array $ACLTokenListEntries = [];
 
     public function getValue(): array
diff --git a/src/Agent/AgentCheckRegistration.php b/src/Agent/AgentCheckRegistration.php
@@ -126,16 +126,6 @@ public function setNamespace(string $Namespace): self
         return $this;
     }
 
-    public static function jsonUnserialize(\stdClass $decoded, null|self|AgentServiceCheck $into = null): static
-    {
-        $n = $into ?? new static();
-        parent::jsonUnserialize($decoded, $n);
-        foreach ($decoded as $k => $v) {
-            $n->{$k} = $v;
-        }
-        return $n;
-    }
-
     public function jsonSerialize(): \stdClass
     {
         $out = parent::jsonSerialize();
diff --git a/src/Agent/AgentHealthServicesResponse.php b/src/Agent/AgentHealthServicesResponse.php
@@ -29,6 +29,7 @@ class AgentHealthServicesResponse extends AbstractResponse
     use ErrorContainer;
 
     public string $AggregatedStatus;
+    /** @var \DCarbone\PHPConsulAPI\Agent\AgentServiceChecksInfo[] */
     public array $AgentServiceChecksInfos;
 
     public function __construct(string $aggregatedStatus, array $checkInfos, null|Error $err)
@@ -46,6 +47,9 @@ public function getAggregatedStatus(): string
         return $this->AggregatedStatus;
     }
 
+    /**
+     * @return \DCarbone\PHPConsulAPI\Agent\AgentServiceChecksInfo[]
+     */
     public function getAgentServiceChecksInfos(): array
     {
         return $this->AgentServiceChecksInfos;
@@ -56,6 +60,10 @@ public function offsetExists(mixed $offset): bool
         return is_int($offset) && 0 <= $offset && $offset < 3;
     }
 
+    /**
+     * @param mixed $offset
+     * @return string|\DCarbone\PHPConsulAPI\Agent\AgentServiceChecksInfo[]|\DCarbone\PHPConsulAPI\Error|null
+     */
     public function offsetGet(mixed $offset): string|array|Error|null
     {
         if (0 === $offset) {
diff --git a/src/Agent/AgentMembersResponse.php b/src/Agent/AgentMembersResponse.php
@@ -25,8 +25,12 @@
 
 class AgentMembersResponse extends AbstractValuedResponse implements UnmarshalledResponseInterface
 {
+    /** @var \DCarbone\PHPConsulAPI\Agent\AgentMember[] */
     public array $Members;
 
+    /**
+     * @return \DCarbone\PHPConsulAPI\Agent\AgentMember[]
+     */
     public function getValue(): array
     {
         return $this->Members;
diff --git a/src/Agent/AgentService.php b/src/Agent/AgentService.php
@@ -176,6 +176,9 @@ public function setAddress(string $Address): self
         return $this;
     }
 
+    /**
+     * @return \DCarbone\PHPConsulAPI\Catalog\ServiceAddress[]
+     */
     public function getTaggedAddresses(): array
     {
         return $this->TaggedAddresses;
diff --git a/src/Agent/AgentServiceCheck.php b/src/Agent/AgentServiceCheck.php
@@ -47,7 +47,6 @@ class AgentServiceCheck extends AbstractModel
     public string $AliasService;
     public int $SuccessBeforePassing;
     public int $FailuresBeforeCritical;
-
     public string $DeregisterCriticalServiceAfter;
 
     public function __construct(
diff --git a/src/Agent/AgentServiceChecks.php b/src/Agent/AgentServiceChecks.php
@@ -22,7 +22,7 @@
 
 use DCarbone\PHPConsulAPI\AbstractModel;
 
-class AgentServiceChecks implements \Countable, \ArrayAccess
+class AgentServiceChecks implements \JsonSerializable, \Countable, \ArrayAccess
 {
     /** @var \DCarbone\PHPConsulAPI\Agent\AgentServiceCheck[] */
     public array $Checks;
@@ -33,6 +33,9 @@ public function __construct(
         $this->setChecks(...$Checks);
     }
 
+    /**
+     * @return \DCarbone\PHPConsulAPI\Agent\AgentServiceCheck[]
+     */
     public function getChecks(): array
     {
         return $this->Checks;
@@ -62,7 +65,7 @@ public function offsetExists(mixed $offset): bool
         return isset($this->Checks[$offset]);
     }
 
-    public function offsetGet(mixed $offset): mixed
+    public function offsetGet(mixed $offset): null|AgentServiceCheck
     {
         return $this->Checks[$offset] ?? null;
     }
@@ -94,4 +97,9 @@ public static function jsonUnserialize(array $decoded): static
         }
         return $n;
     }
+
+    public function jsonSerialize(): array
+    {
+        return $this->Checks;
+    }
 }
diff --git a/src/Agent/AgentServiceConnectProxyConfig.php b/src/Agent/AgentServiceConnectProxyConfig.php
diff --git a/src/Agent/AgentServiceRegistration.php b/src/Agent/AgentServiceRegistration.php
diff --git a/src/Agent/MetricsInfo.php b/src/Agent/MetricsInfo.php
diff --git a/src/Agent/PointValue.php b/src/Agent/PointValue.php
diff --git a/src/ErrorContainer.php b/src/ErrorContainer.php

Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,7 @@`
`25`	`25`
`26`	`26`	`class ACLAuthMethodListEntryQueryResponse extends AbstractValuedQueryResponse implements UnmarshalledResponseInterface`
`27`	`27`	`{`
	`28`	`+ /** @var \DCarbone\PHPConsulAPI\ACL\ACLAuthMethodListEntry[] */`
`28`	`29`	`public array $ACLAuthMethodListEntries = [];`
`29`	`30`
`30`	`31`	`public function getValue(): array`
Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,7 @@ class ACLTemplatedPolicy extends AbstractModel`
`26`	`26`	`{`
`27`	`27`	`public string $TemplateName;`
`28`	`28`	`public null\|ACLTemplatedPolicyVariables $TemplateVariables;`
	`29`	`+ /** @var string[] */`
`29`	`30`	`public array $Datacenters;`
`30`	`31`
`31`	`32`	`public function __construct(`
`@@ -60,6 +61,9 @@ public function setTemplateVariables(null\|ACLTemplatedPolicyVariables $TemplateV`
`60`	`61`	`return $this;`
`61`	`62`	`}`
`62`	`63`
	`64`	`+ /**`
	`65`	`+ * @return string[]`
	`66`	`+ */`
`63`	`67`	`public function getDatacenters(): array`
`64`	`68`	`{`
`65`	`69`	`return $this->Datacenters;`
Original file line number	Diff line number	Diff line change
`@@ -100,6 +100,9 @@ public function __construct(`
`100`	`100`	`}`
`101`	`101`	`}`
`102`	`102`
	`103`	`+ /**`
	`104`	`+ * @return \DCarbone\PHPConsulAPI\ACL\ACLPolicy[]`
	`105`	`+ */`
`103`	`106`	`public function getExpandedPolicies(): array`
`104`	`107`	`{`
`105`	`108`	`return $this->ExpandedPolicies;`
`@@ -111,6 +114,9 @@ public function setExpandedPolicies(ACLPolicy ...$ExpandedPolicies): self`
`111`	`114`	`return $this;`
`112`	`115`	`}`
`113`	`116`
	`117`	`+ /**`
	`118`	`+ * @return \DCarbone\PHPConsulAPI\ACL\ACLRole[]`
	`119`	`+ */`
`114`	`120`	`public function getExpandedRoles(): array`
`115`	`121`	`{`
`116`	`122`	`return $this->ExpandedRoles;`
`@@ -122,6 +128,9 @@ public function setExpandedRoles(ACLRole ...$ExpandedRoles): self`
`122`	`128`	`return $this;`
`123`	`129`	`}`
`124`	`130`
	`131`	`+ /**`
	`132`	`+ * @return string[]`
	`133`	`+ */`
`125`	`134`	`public function getNamespaceDefaultPolicyIDs(): array`
`126`	`135`	`{`
`127`	`136`	`return $this->NamespaceDefaultPolicyIDs;`
`@@ -133,6 +142,9 @@ public function setNamespaceDefaultPolicyIDs(string ...$NamespaceDefaultPolicyID`
`133`	`142`	`return $this;`
`134`	`143`	`}`
`135`	`144`
	`145`	`+ /**`
	`146`	`+ * @return string[]`
	`147`	`+ */`
`136`	`148`	`public function getNamespaceDefaultRoleIDs(): array`
`137`	`149`	`{`
`138`	`150`	`return $this->NamespaceDefaultRoleIDs;`
Original file line number	Diff line number	Diff line change
`@@ -106,6 +106,9 @@ public function setDescription(string $Description): self`
`106`	`106`	`return $this;`
`107`	`107`	`}`
`108`	`108`
	`109`	`+ /**`
	`110`	`+ * @return \DCarbone\PHPConsulAPI\ACL\ACLTokenPolicyLink[]`
	`111`	`+ */`
`109`	`112`	`public function getPolicies(): array`
`110`	`113`	`{`
`111`	`114`	`return $this->Policies;`
`@@ -117,6 +120,9 @@ public function setPolicies(ACLTokenPolicyLink ...$Policies): self`
`117`	`120`	`return $this;`
`118`	`121`	`}`
`119`	`122`
	`123`	`+ /**`
	`124`	`+ * @return \DCarbone\PHPConsulAPI\ACL\ACLTokenRoleLink[]`
	`125`	`+ */`
`120`	`126`	`public function getRoles(): array`
`121`	`127`	`{`
`122`	`128`	`return $this->Roles;`
`@@ -128,6 +134,9 @@ public function setRoles(ACLTokenRoleLink ...$Roles): self`
`128`	`134`	`return $this;`
`129`	`135`	`}`
`130`	`136`
	`137`	`+ /**`
	`138`	`+ * @return \DCarbone\PHPConsulAPI\ACL\ACLServiceIdentity[]`
	`139`	`+ */`
`131`	`140`	`public function getServiceIdentities(): array`
`132`	`141`	`{`
`133`	`142`	`return $this->ServiceIdentities;`
`@@ -139,6 +148,9 @@ public function setServiceIdentities(ACLServiceIdentity ...$ServiceIdentities):`
`139`	`148`	`return $this;`
`140`	`149`	`}`
`141`	`150`
	`151`	`+ /**`
	`152`	`+ * @return \DCarbone\PHPConsulAPI\ACL\ACLNodeIdentity[]`
	`153`	`+ */`
`142`	`154`	`public function getNodeIdentities(): array`
`143`	`155`	`{`
`144`	`156`	`return $this->NodeIdentities;`
`@@ -150,6 +162,9 @@ public function setNodeIdentities(ACLNodeIdentity ...$NodeIdentities): self`
`150`	`162`	`return $this;`
`151`	`163`	`}`
`152`	`164`
	`165`	`+ /**`
	`166`	`+ * @return \DCarbone\PHPConsulAPI\ACL\ACLTemplatedPolicy[]`
	`167`	`+ */`
`153`	`168`	`public function getTemplatePolicies(): array`
`154`	`169`	`{`
`155`	`170`	`return $this->TemplatePolicies;`