Merge pull request #36 from ohdearapp/feature/domain-monitoring

feat: add support for Domain Monitoring

src/Actions/ManagesDomainMonitoring.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace OhDear\PhpSdk\Actions;
+
+use OhDear\PhpSdk\Resources\Domain;
+
+trait ManagesDomainMonitoring
+{
+    public function domain(int $siteId): Domain
+    {
+        return new Domain(
+            $this->get("sites/{$siteId}/domain"),
+            $this
+        );
+    }
+}

src/Actions/ManagesDowntime.php

@@ -7,10 +7,8 @@
 trait ManagesDowntime
 {
     /**
-     * @param  int  $siteId
      * @param  string  $startedAt Short (2020-12-01) or long (2020-12-01 15:00:00) date format
      * @param  string  $endedAt Short (2020-12-01) or long (2020-12-01 15:00:00) date format
-     * @return array
      */
     public function downtime(int $siteId, string $startedAt, string $endedAt): array
     {

src/Actions/ManagesLighthouseReports.php

@@ -7,7 +7,6 @@
 trait ManagesLighthouseReports
 {
     /**
-     * @param  int  $siteId
      * @return array<LighthouseReport>
      */
     public function lighthouseReports(int $siteId): array

src/Actions/ManagesMaintenancePeriods.php

@@ -6,10 +6,6 @@
 
 trait ManagesMaintenancePeriods
 {
-    /**
-     * @param  int  $siteId
-     * @return array
-     */
     public function maintenancePeriods(int $siteId): array
     {
         return $this->transformCollection(
@@ -19,9 +15,7 @@ public function maintenancePeriods(int $siteId): array
     }
 
     /**
-     * @param  int  $siteId
      * @param  int  $stopMaintenanceAfterSeconds Stops after one hour by default
-     * @return MaintenancePeriod
      */
     public function startSiteMaintenance(int $siteId, int $stopMaintenanceAfterSeconds = 60 * 60): MaintenancePeriod
     {
@@ -32,19 +26,14 @@ public function startSiteMaintenance(int $siteId, int $stopMaintenanceAfterSecon
         return new MaintenancePeriod($attributes, $this);
     }
 
-    /**
-     * @param  int  $siteId
-     */
     public function stopSiteMaintenance(int $siteId)
     {
         $this->post("sites/{$siteId}/stop-maintenance");
     }
 
     /**
-     * @param  int  $siteId
      * @param  string  $startsAt Y-m-d H:i
      * @param  string  $endsAt Y-m-d H:i
-     * @return MaintenancePeriod
      */
     public function createSiteMaintenance(int $siteId, string $startsAt, string $endsAt): MaintenancePeriod
     {
@@ -62,9 +51,6 @@ public function createSiteMaintenance(int $siteId, string $startsAt, string $end
         return new MaintenancePeriod($attributes, $this);
     }
 
-    /**
-     * @param  int  $maintenancePeriodId
-     */
     public function deleteSiteMaintenance(int $maintenancePeriodId)
     {
         $this->delete("maintenance-periods/{$maintenancePeriodId}");

src/Actions/ManagesPerformance.php

@@ -7,12 +7,9 @@
 trait ManagesPerformance
 {
     /**
-     * @param  int  $siteId
      * @param  string  $start Short (2020-12-01) or long (2020-12-01 15:00:00) date format
      * @param  string  $end Short (2020-12-01) or long (2020-12-01 15:00:00) date format
      * @param  string  $timeframe Should be 1m or 1h
-     * @param  string  $sort
-     * @return array
      */
     public function performanceRecords(
         int $siteId,

src/Actions/ManagesUptime.php

@@ -7,11 +7,9 @@
 trait ManagesUptime
 {
     /**
-     * @param  int  $siteId
      * @param  string  $startedAt  Must be in format Ymdhis
      * @param  string  $endedAt  Must be in format Ymdhis
      * @param  string  $split  Use hour, day or month
-     * @return array
      */
     public function uptime(int $siteId, string $startedAt, string $endedAt, string $split = 'month'): array
     {

src/OhDear.php

@@ -10,6 +10,7 @@
 use OhDear\PhpSdk\Actions\ManagesChecks;
 use OhDear\PhpSdk\Actions\ManagesCronChecks;
 use OhDear\PhpSdk\Actions\ManagesDnsHistoryItems;
+use OhDear\PhpSdk\Actions\ManagesDomainMonitoring;
 use OhDear\PhpSdk\Actions\ManagesDowntime;
 use OhDear\PhpSdk\Actions\ManagesLighthouseReports;
 use OhDear\PhpSdk\Actions\ManagesMaintenancePeriods;
@@ -24,22 +25,23 @@
 class OhDear
 {
     use MakesHttpRequests;
-    use ManagesSites;
-    use ManagesChecks;
-    use ManagesUsers;
+    use ManagesApplicationHealthChecks;
     use ManagesBrokenLinks;
-    use ManagesMaintenancePeriods;
-    use ManagesMixedContent;
-    use ManagesUptime;
-    use ManagesDowntime;
     use ManagesCertificateHealth;
-    use ManagesApplicationHealthChecks;
+    use ManagesChecks;
+    use ManagesCronChecks;
+    use ManagesDnsHistoryItems;
+    use ManagesDomainMonitoring;
+    use ManagesDowntime;
     use ManagesLighthouseReports;
+    use ManagesMaintenancePeriods;
+    use ManagesMixedContent;
+    use ManagesPerformance;
+    use ManagesSites;
     use ManagesStatusPages;
     use ManagesStatusPageUpdates;
-    use ManagesPerformance;
-    use ManagesCronChecks;
-    use ManagesDnsHistoryItems;
+    use ManagesUptime;
+    use ManagesUsers;
 
     public string $apiToken;
 

src/Resources/Domain.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace OhDear\PhpSdk\Resources;
+
+class Domain extends ApiResource
+{
+    public string $expiresAt;
+
+    public string $registeredAt;
+
+    public string $lastChangedAt;
+
+    public string $lastUpdatedInRdapDbAt;
+
+    /** @var array<string, bool> */
+    public array $domainStatuses;
+
+    public array $rdapDomainResponse;
+
+    public string $createdAt;
+}

src/Resources/Site.php

@@ -57,7 +57,6 @@ public function mixedContent(): array
      * @param  string  $startedAt  Must be in format Ymdhis
      * @param  string  $endedAt  Must be in format Ymdhis
      * @param  string  $split  Use hour, day or month
-     * @return array
      */
     public function uptime(string $startedAt, string $endedAt, string $split): array
     {
@@ -69,7 +68,6 @@ public function uptime(string $startedAt, string $endedAt, string $split): array
      *
      * @param  string  $startedAt  Must be in format Ymdhis
      * @param  string  $endedAt  Must be in format Ymdhis
-     * @return array
      */
     public function downtime(string $startedAt, string $endedAt): array
     {