Merge pull request #68 from ohdearapp/reseller-api-updates

Add reseller endpoints to the SDK

Author: mattiasgeniar

README.md

@@ -1061,6 +1061,42 @@ $destination = $ohDear->updateTagGroupNotificationDestination($tagGroupId, $dest
 $ohDear->deleteTagGroupNotificationDestination($tagGroupId, $destinationId);
 ```
 
+### [Reseller / Managed Teams](https://ohdear.app/docs/api/reseller)
+
+If you're an Oh Dear reseller, you can manage teams through the reseller API. All methods require your reseller team ID.
+
+```php
+// List all managed teams
+$teams = $ohDear->managedTeams($resellerTeamId);
+
+// Get a single managed team
+$team = $ohDear->managedTeam($resellerTeamId, $managedTeamId);
+
+// Create a managed team
+$team = $ohDear->createManagedTeam($resellerTeamId, [
+    'name' => 'Client Company',
+    'timezone' => 'Europe/Brussels',
+    'default_uptime_check_location' => 'eu-west',
+]);
+
+// Update a managed team
+$team = $ohDear->updateManagedTeam($resellerTeamId, $managedTeamId, [
+    'name' => 'Updated Company Name',
+    'timezone' => 'Europe/London',
+    'default_uptime_check_location' => 'us-east',
+]);
+
+// Get a login link for a managed team
+$loginLink = $ohDear->managedTeamLoginLink($resellerTeamId, $managedTeamId);
+echo $loginLink['login_url'];
+
+// Decouple a team (team becomes independent)
+$ohDear->decoupleManagedTeam($resellerTeamId, $managedTeamId);
+
+// Delete a managed team and all its data
+$ohDear->deleteManagedTeam($resellerTeamId, $managedTeamId);
+```
+
 ### Using Saloon requests directly
 
 This SDK uses [Saloon](https://docs.saloon.dev) to make the HTTP requests. Instead of using the `OhDear` class, you can the underlying request classes directly. This way, you have full power to customize the requests.

src/Concerns/SupportsManagedTeamEndpoints.php

@@ -0,0 +1,69 @@
+<?php
+
+namespace OhDear\PhpSdk\Concerns;
+
+use OhDear\PhpSdk\Dto\ManagedTeam;
+use OhDear\PhpSdk\Requests\ManagedTeams\CreateManagedTeamRequest;
+use OhDear\PhpSdk\Requests\ManagedTeams\DecoupleManagedTeamRequest;
+use OhDear\PhpSdk\Requests\ManagedTeams\DeleteManagedTeamRequest;
+use OhDear\PhpSdk\Requests\ManagedTeams\GetManagedTeamLoginLinkRequest;
+use OhDear\PhpSdk\Requests\ManagedTeams\GetManagedTeamRequest;
+use OhDear\PhpSdk\Requests\ManagedTeams\GetManagedTeamsRequest;
+use OhDear\PhpSdk\Requests\ManagedTeams\UpdateManagedTeamRequest;
+
+/** @mixin \OhDear\PhpSdk\OhDear */
+trait SupportsManagedTeamEndpoints
+{
+    public function managedTeams(int $resellerTeamId): array
+    {
+        $request = new GetManagedTeamsRequest($resellerTeamId);
+
+        return $this->send($request)->dtoOrFail();
+    }
+
+    public function managedTeam(int $resellerTeamId, int $managedTeamId): ManagedTeam
+    {
+        $request = new GetManagedTeamRequest($resellerTeamId, $managedTeamId);
+
+        return $this->send($request)->dto();
+    }
+
+    public function createManagedTeam(int $resellerTeamId, array $data): ManagedTeam
+    {
+        $request = new CreateManagedTeamRequest($resellerTeamId, $data);
+
+        return $this->send($request)->dto();
+    }
+
+    public function updateManagedTeam(int $resellerTeamId, int $managedTeamId, array $data): ManagedTeam
+    {
+        $request = new UpdateManagedTeamRequest($resellerTeamId, $managedTeamId, $data);
+
+        return $this->send($request)->dto();
+    }
+
+    public function decoupleManagedTeam(int $resellerTeamId, int $managedTeamId): self
+    {
+        $request = new DecoupleManagedTeamRequest($resellerTeamId, $managedTeamId);
+
+        $this->send($request);
+
+        return $this;
+    }
+
+    public function deleteManagedTeam(int $resellerTeamId, int $managedTeamId): self
+    {
+        $request = new DeleteManagedTeamRequest($resellerTeamId, $managedTeamId);
+
+        $this->send($request);
+
+        return $this;
+    }
+
+    public function managedTeamLoginLink(int $resellerTeamId, int $managedTeamId): array
+    {
+        $request = new GetManagedTeamLoginLinkRequest($resellerTeamId, $managedTeamId);
+
+        return $this->send($request)->dto();
+    }
+}

src/Concerns/SupportsPortsHistoryItemsEndpoints.php

@@ -20,6 +20,6 @@ public function portsHistoryItem(int $monitorId, int $portsHistoryItemId): Ports
     {
         $request = new GetPortsHistoryItemRequest($monitorId, $portsHistoryItemId);
 
-        return $this->send($request)->dto();
+        return $this->send($request)->dtoOrFail();
     }
 }

src/Dto/ManagedTeam.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace OhDear\PhpSdk\Dto;
+
+class ManagedTeam
+{
+    public function __construct(
+        public int $id,
+        public string $name,
+        public ?string $timezone,
+        public ?string $createdAt,
+        public ?int $monitorsCount,
+    ) {}
+
+    public static function fromResponse(array $data): self
+    {
+        return new self(
+            id: $data['id'],
+            name: $data['name'],
+            timezone: $data['timezone'] ?? null,
+            createdAt: $data['created_at'] ?? null,
+            monitorsCount: $data['monitors_count'] ?? null,
+        );
+    }
+
+    public static function collect(array $items): array
+    {
+        return array_map(fn (array $item) => self::fromResponse($item), $items);
+    }
+}

src/Dto/PortsHistoryItem.php

@@ -7,8 +7,8 @@ class PortsHistoryItem
     public function __construct(
         public int $id,
         public ?string $scannedHost,
-        public array $expectedOpenResults,
-        public array $expectedClosedResults,
+        public ?string $resolvedIp,
+        public array $openPorts,
         public array $issues,
         public ?int $scanTimeMs,
         public ?string $createdAt,
@@ -19,8 +19,8 @@ public static function fromResponse(array $data): self
         return new self(
             id: $data['id'],
             scannedHost: $data['scanned_host'] ?? null,
-            expectedOpenResults: $data['expected_open_results'] ?? [],
-            expectedClosedResults: $data['expected_closed_results'] ?? [],
+            resolvedIp: $data['resolved_ip'] ?? null,
+            openPorts: $data['open_ports'] ?? [],
             issues: $data['issues'] ?? [],
             scanTimeMs: $data['scan_time_ms'] ?? null,
             createdAt: $data['created_at'] ?? null,

src/OhDear.php

@@ -15,6 +15,7 @@
 use OhDear\PhpSdk\Concerns\SupportsDowntimeEndpoints;
 use OhDear\PhpSdk\Concerns\SupportsLighthouseReportsEndpoints;
 use OhDear\PhpSdk\Concerns\SupportsMaintenancePeriodEndpoints;
+use OhDear\PhpSdk\Concerns\SupportsManagedTeamEndpoints;
 use OhDear\PhpSdk\Concerns\SupportsMeEndpoint;
 use OhDear\PhpSdk\Concerns\SupportsMixedContentEndpoints;
 use OhDear\PhpSdk\Concerns\SupportsMonitorEndpoints;
@@ -58,6 +59,7 @@ class OhDear extends Connector implements HasPagination
     use SupportsDowntimeEndpoints;
     use SupportsLighthouseReportsEndpoints;
     use SupportsMaintenancePeriodEndpoints;
+    use SupportsManagedTeamEndpoints;
     use SupportsMeEndpoint;
     use SupportsMixedContentEndpoints;
     use SupportsMonitorEndpoints;

src/Requests/ManagedTeams/CreateManagedTeamRequest.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace OhDear\PhpSdk\Requests\ManagedTeams;
+
+use OhDear\PhpSdk\Dto\ManagedTeam;
+use Saloon\Contracts\Body\HasBody;
+use Saloon\Enums\Method;
+use Saloon\Http\Request;
+use Saloon\Http\Response;
+use Saloon\Traits\Body\HasJsonBody;
+
+class CreateManagedTeamRequest extends Request implements HasBody
+{
+    use HasJsonBody;
+
+    protected Method $method = Method::POST;
+
+    public function __construct(
+        protected int $resellerTeamId,
+        protected array $data,
+    ) {}
+
+    public function resolveEndpoint(): string
+    {
+        return "/reseller/{$this->resellerTeamId}/managed-teams";
+    }
+
+    protected function defaultBody(): array
+    {
+        return $this->data;
+    }
+
+    public function createDtoFromResponse(Response $response): ManagedTeam
+    {
+        return ManagedTeam::fromResponse($response->json());
+    }
+}

src/Requests/ManagedTeams/DecoupleManagedTeamRequest.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace OhDear\PhpSdk\Requests\ManagedTeams;
+
+use Saloon\Enums\Method;
+use Saloon\Http\Request;
+
+class DecoupleManagedTeamRequest extends Request
+{
+    protected Method $method = Method::POST;
+
+    public function __construct(
+        protected int $resellerTeamId,
+        protected int $managedTeamId,
+    ) {}
+
+    public function resolveEndpoint(): string
+    {
+        return "/reseller/{$this->resellerTeamId}/managed-teams/{$this->managedTeamId}/decouple";
+    }
+}

src/Requests/ManagedTeams/DeleteManagedTeamRequest.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace OhDear\PhpSdk\Requests\ManagedTeams;
+
+use Saloon\Enums\Method;
+use Saloon\Http\Request;
+
+class DeleteManagedTeamRequest extends Request
+{
+    protected Method $method = Method::DELETE;
+
+    public function __construct(
+        protected int $resellerTeamId,
+        protected int $managedTeamId,
+    ) {}
+
+    public function resolveEndpoint(): string
+    {
+        return "/reseller/{$this->resellerTeamId}/managed-teams/{$this->managedTeamId}";
+    }
+}

src/Requests/ManagedTeams/GetManagedTeamLoginLinkRequest.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace OhDear\PhpSdk\Requests\ManagedTeams;
+
+use Saloon\Enums\Method;
+use Saloon\Http\Request;
+use Saloon\Http\Response;
+
+class GetManagedTeamLoginLinkRequest extends Request
+{
+    protected Method $method = Method::GET;
+
+    public function __construct(
+        protected int $resellerTeamId,
+        protected int $managedTeamId,
+    ) {}
+
+    public function resolveEndpoint(): string
+    {
+        return "/reseller/{$this->resellerTeamId}/managed-teams/{$this->managedTeamId}/login-link";
+    }
+
+    public function createDtoFromResponse(Response $response): array
+    {
+        return $response->json();
+    }
+}