use periodyears

Author: ChiragAgg5k

README.md

@@ -127,11 +127,11 @@ $transfer = $reg->transfer($domain, 'authcode', [$contact]);
 
 ## Library Registrar API
 * **available(string $domain): bool** - Checks to see if a domain is available for registration.
-* **purchase(string $domain, array $contacts, int $period = 1, array $nameservers = []): array** - Purchase a domain name.
+* **purchase(string $domain, array $contacts, int $periodYears = 1, array $nameservers = []): array** - Purchase a domain name.
 * **suggest(array $query, array $tlds = [], int|null $limit = null, int|null $priceMax = null, int|null $priceMin = null): array** - Suggest or search for domain names.
 * **getDomain(string $domain): array** - Get domain details.
-* **renew(string $domain, int $period): array** - Renew a domain name.
-* **transfer(string $domain, string $authCode, array $contacts, int $period = 1, array $nameservers = []): array** - Transfer a domain name.
+* **renew(string $domain, int $periodYears): array** - Renew a domain name.
+* **transfer(string $domain, string $authCode, array $contacts, int $periodYears = 1, array $nameservers = []): array** - Transfer a domain name.
 
 
 ## System Requirements

src/Domains/Registrar.php

@@ -51,14 +51,14 @@ public function available(string $domain): bool
      * Purchase a domain
      *
      * @param string $domain
-     * @param int $period
+     * @param int $periodYears
      * @param array|Contact $contacts
      * @param array $nameservers
      * @return PurchaseResult
      */
-    public function purchase(string $domain, array|Contact $contacts, int $period = 1, array $nameservers = []): PurchaseResult
+    public function purchase(string $domain, array|Contact $contacts, int $periodYears = 1, array $nameservers = []): PurchaseResult
     {
-        return $this->adapter->purchase($domain, $contacts, $period, $nameservers);
+        return $this->adapter->purchase($domain, $contacts, $periodYears, $nameservers);
     }
 
     /**
@@ -115,26 +115,26 @@ public function updateDomain(string $domain, array $details, array|Contact|null
      * Get the price of a domain
      *
      * @param string $domain
-     * @param int $period
+     * @param int $periodYears
      * @param string $regType
      * @param int $ttl
      * @return PriceResult
      */
-    public function getPrice(string $domain, int $period = 1, string $regType = self::REG_TYPE_NEW, int $ttl = 3600): PriceResult
+    public function getPrice(string $domain, int $periodYears = 1, string $regType = self::REG_TYPE_NEW, int $ttl = 3600): PriceResult
     {
-        return $this->adapter->getPrice($domain, $period, $regType, $ttl);
+        return $this->adapter->getPrice($domain, $periodYears, $regType, $ttl);
     }
 
     /**
      * Renew a domain
      *
      * @param string $domain
-     * @param int $period
+     * @param int $periodYears
      * @return RenewResult
      */
-    public function renew(string $domain, int $period): RenewResult
+    public function renew(string $domain, int $periodYears): RenewResult
     {
-        return $this->adapter->renew($domain, $period);
+        return $this->adapter->renew($domain, $periodYears);
     }
 
     /**
@@ -146,9 +146,9 @@ public function renew(string $domain, int $period): RenewResult
      * @param array $nameservers
      * @return TransferResult
      */
-    public function transfer(string $domain, string $authCode, array|Contact $contacts, int $period = 1, array $nameservers = []): TransferResult
+    public function transfer(string $domain, string $authCode, array|Contact $contacts, int $periodYears = 1, array $nameservers = []): TransferResult
     {
-        return $this->adapter->transfer($domain, $authCode, $contacts, $period, $nameservers);
+        return $this->adapter->transfer($domain, $authCode, $contacts, $periodYears, $nameservers);
     }
 
     /**

src/Domains/Registrar/Result/PurchaseResult.php

@@ -10,7 +10,7 @@ public function __construct(
         public string $domainId,
         public bool $successful,
         public ?string $domain = null,
-        public ?int $period = null,
+        public ?int $periodYears = null,
         public ?array $nameservers = null,
     ) {
     }

src/Domains/Registrar/Result/TransferResult.php

@@ -10,7 +10,7 @@ public function __construct(
         public string $domainId,
         public bool $successful,
         public ?string $domain = null,
-        public ?int $period = null,
+        public ?int $periodYears = null,
         public ?array $nameservers = null,
     ) {
     }