v3.0.0

- Refactor lib to always return an API Response
- Add missing fields/functions from API documentation

Author: LKaemmerling

src/HetznerAPIClient.php

@@ -32,7 +32,7 @@ class HetznerAPIClient
     /**
      * Version of the API Client.
      */
-    const VERSION = '2.9.1';
+    const VERSION = '3.0.0-alpha.1';
 
     const MAX_ENTITIES_PER_PAGE = 50;
 

src/Models/Actions/Action.php

@@ -28,12 +28,12 @@ class Action extends Model implements Resource
     public $progress;
 
     /**
-     * @var string
+     * @var string|null
      */
     public $started;
 
     /**
-     * @var string
+     * @var string|null
      */
     public $finished;
 
@@ -66,7 +66,7 @@ public function __construct(
         string $command,
         int $progress,
         string $status,
-        string $started,
+        ?string $started = null,
         ?string $finished = null,
         $resources = null,
         $error = null
@@ -148,6 +148,6 @@ public static function parse($input)
             return;
         }
 
-        return new self($input->id, $input->command, $input->progress, $input->status, $input->started, $input->finished, $input->resources, $input->error ?? null);
+        return new self($input->id, $input->command, $input->progress, $input->status, $input->started ?? null, $input->finished ?? null, $input->resources, $input->error ?? null);
     }
 }

src/Models/Certificates/Certificate.php

@@ -57,6 +57,10 @@ class Certificate extends Model implements Resource
      * @var array
      */
     public $labels;
+    /**
+     * @var string
+     */
+    public $type;
 
     /**
      * Certificate constructor.
@@ -71,8 +75,9 @@ class Certificate extends Model implements Resource
      * @param  string|null  $fingerprint
      * @param  array|null  $used_by
      * @param  array|null  $labels
+     * @param  string|null  $type
      */
-    public function __construct(int $id, ?string $name = null, ?string $certificate = null, ?string $created = null, ?string $not_valid_before = null, ?string $not_valid_after = null, ?array $domain_names = null, ?string $fingerprint = null, $used_by = null, $labels = [])
+    public function __construct(int $id, ?string $name = null, ?string $certificate = null, ?string $created = null, ?string $not_valid_before = null, ?string $not_valid_after = null, ?array $domain_names = null, ?string $fingerprint = null, $used_by = null, $labels = [], ?string $type = null)
     {
         $this->id = $id;
         $this->name = $name;
@@ -84,6 +89,7 @@ public function __construct(int $id, ?string $name = null, ?string $certificate
         $this->fingerprint = $fingerprint;
         $this->used_by = $used_by;
         $this->labels = $labels;
+        $this->type = $type;
 
         parent::__construct();
     }
@@ -136,7 +142,7 @@ public function delete(): bool
      */
     public static function parse($input)
     {
-        return new self($input->id, $input->name, $input->certificate, $input->created, $input->not_valid_before, $input->not_valid_after, $input->domain_names, $input->fingerprint, $input->used_by, $input->labels);
+        return new self($input->id, $input->name, $input->certificate, $input->created, $input->not_valid_before, $input->not_valid_after, $input->domain_names, $input->fingerprint, $input->used_by, $input->labels, $input->type ?? null);
     }
 
     /**

src/Models/Certificates/Certificates.php

@@ -41,15 +41,21 @@ class Certificates extends Model implements Resources
      */
     public function create(
         string $name,
-        string $certificate,
-        string $privateKey,
-        array $labels = []
+        ?string $certificate = null,
+        ?string $privateKey = null,
+        array $labels = [],
+        string $type = 'uploaded'
     ): ?Certificate {
         $parameters = [
             'name' => $name,
-            'certificate' => $certificate,
-            'private_key' => $privateKey,
+            'type' => $type,
         ];
+        if ($certificate !== null) {
+            $parameters['certificate'] = $certificate;
+        }
+        if ($privateKey !== null) {
+            $parameters['private_key'] = $privateKey;
+        }
         if (! empty($labels)) {
             $parameters['labels'] = $labels;
         }

src/Models/Firewalls/Firewall.php

@@ -119,12 +119,14 @@ public static function parse($input): ?self
         $rules = [];
 
         foreach ($input->rules as $r) {
-            $rules[] = new FirewallRule($r->direction, $r->protocol, $r->source_ips, $r->destination_ips, (string) $r->port);
+            $rules[] = new FirewallRule($r->direction, $r->protocol, (isset($r->source_ips)) ? $r->source_ips : [], (isset($r->destination_ips)) ? $r->destination_ips : [], (isset($r->port)) ? (string) $r->port : '', (isset($r->description)) ? $r->description : '');
         }
 
         foreach ($input->applied_to as $a) {
             if ($a->type === 'server') {
                 $appliedTo[] = new FirewallResource($a->type, new Server($a->server->id));
+            } elseif ($a->type === 'label_selector') {
+                $appliedTo[] = new FirewallResource($a->type, null, get_object_vars($a->label_selector));
             }
         }
 
@@ -168,18 +170,18 @@ public function setRules(array $rules): ?ApiResponse
      *
      * @see https://docs.hetzner.cloud/#firewalls-delete-a-firewall
      *
-     * @return bool
+     * @return APIResponse|null
      *
      * @throws \LKDev\HetznerCloud\APIException
      */
-    public function delete(): bool
+    public function delete(): ?APIResponse
     {
         $response = $this->httpClient->delete('firewalls/'.$this->id);
         if (! HetznerAPIClient::hasError($response)) {
-            return true;
+            return APIResponse::create([], $response->getHeaders());
         }
 
-        return false;
+        return null;
     }
 
     /**

src/Models/Firewalls/FirewallResource.php

@@ -11,6 +11,8 @@ class FirewallResource
 {
     const TYPE_SERVER = 'server';
 
+    const TYPE_LABEL_SELECTOR = 'label_selector';
+
     /**
      * @var string
      */
@@ -20,26 +22,35 @@ class FirewallResource
      */
     public $server;
 
+    /**
+     * @var ?array
+     */
+    public $labelSelector;
+
     /**
      * FirewallResource constructor.
      *
      * @param  string  $type
      * @param  Server|null  $server
+     * @param  array|null  $labelSelector
      */
-    public function __construct(string $type, ?Server $server)
+    public function __construct(string $type, ?Server $server = null, ?array $labelSelector = null)
     {
         $this->type = $type;
         $this->server = $server;
+        $this->labelSelector = $labelSelector;
     }
 
     /**
-     * @return string[]
+     * @return array
      */
     public function toRequestSchema(): array
     {
         $s = ['type' => $this->type];
         if ($this->type == self::TYPE_SERVER) {
             $s['server'] = ['id' => $this->server->id];
+        } elseif ($this->type == self::TYPE_LABEL_SELECTOR) {
+            $s['label_selector'] = $this->labelSelector;
         }
 
         return $s;

src/Models/Firewalls/FirewallRule.php

@@ -37,6 +37,11 @@ class FirewallRule
      */
     public $port;
 
+    /**
+     * @var string
+     */
+    public $description;
+
     /**
      * FirewallRule constructor.
      *
@@ -45,14 +50,16 @@ class FirewallRule
      * @param  string[]  $destinationIPs
      * @param  string  $protocol
      * @param  string  $port
+     * @param  string  $description
      */
-    public function __construct(string $direction, string $protocol, array $sourceIPs = [], array $destinationIPs = [], ?string $port = '')
+    public function __construct(string $direction, string $protocol, array $sourceIPs = [], array $destinationIPs = [], ?string $port = '', ?string $description = '')
     {
         $this->direction = $direction;
         $this->sourceIPs = $sourceIPs;
         $this->destinationIPs = $destinationIPs;
         $this->protocol = $protocol;
         $this->port = $port;
+        $this->description = $description;
     }
 
     /**
@@ -71,6 +78,9 @@ public function toRequestSchema(): array
         if ($this->port != '') {
             $s['port'] = $this->port;
         }
+        if ($this->description != '') {
+            $s['description'] = $this->description;
+        }
 
         return $s;
     }

src/Models/FloatingIps/FloatingIp.php

@@ -181,18 +181,18 @@ public function changeDescription(string $description): ?self
      *
      * @see https://docs.hetzner.cloud/#resources-floating-ips-delete
      *
-     * @return bool
+     * @return APIResponse|null
      *
      * @throws \LKDev\HetznerCloud\APIException
      */
-    public function delete(): bool
+    public function delete(): ?APIResponse
     {
         $response = $this->httpClient->delete('floating_ips/'.$this->id);
         if (! HetznerAPIClient::hasError($response)) {
-            return true;
+            return APIResponse::create([], $response->getHeaders());
         }
 
-        return false;
+        return null;
     }
 
     /**

src/Models/FloatingIps/FloatingIps.php

@@ -123,7 +123,7 @@ public function getByName(string $name): ?FloatingIp
      * @param  \LKDev\HetznerCloud\Models\Servers\Server|null  $server
      * @param  string|null  $name
      * @param  array  $labels
-     * @return \LKDev\HetznerCloud\Models\FloatingIps\FloatingIp|null
+     * @return \LKDev\HetznerCloud\APIResponse|null
      *
      * @throws \LKDev\HetznerCloud\APIException
      */
@@ -134,7 +134,7 @@ public function create(
         ?Server $server = null,
         ?string $name = null,
         array $labels = []
-    ): ?FloatingIp {
+    ): ?APIResponse {
         $parameters = [
             'type' => $type,
         ];
@@ -157,7 +157,12 @@ public function create(
             'json' => $parameters,
         ]);
         if (! HetznerAPIClient::hasError($response)) {
-            return FloatingIp::parse(json_decode((string) $response->getBody())->{$this->_getKeys()['one']});
+            $payload = json_decode((string) $response->getBody());
+
+            return APIResponse::create([
+                'floating_ip' => FloatingIp::parse($payload->floating_ip),
+                'action' => property_exists($payload, 'action') ? \LKDev\HetznerCloud\Models\Actions\Action::parse($payload->action) : null,
+            ], $response->getHeaders());
         }
 
         return null;

src/Models/ISOs/ISO.php

@@ -28,20 +28,34 @@ class ISO extends Model implements Resource
      */
     public $type;
 
+    /**
+     * @var string
+     */
+    public $architecture;
+
+    /**
+     * @var string|null
+     */
+    public $deprecated;
+
     /**
      * ISO constructor.
      *
      * @param  int  $id
      * @param  string  $name
      * @param  string  $description
      * @param  string  $type
+     * @param  string  $architecture
+     * @param  string|null  $deprecated
      */
-    public function __construct(int $id, ?string $name = null, ?string $description = null, ?string $type = null)
+    public function __construct(int $id, ?string $name = null, ?string $description = null, ?string $type = null, ?string $architecture = null, ?string $deprecated = null)
     {
         $this->id = $id;
         $this->name = $name;
         $this->description = $description;
         $this->type = $type;
+        $this->architecture = $architecture;
+        $this->deprecated = $deprecated;
         parent::__construct();
     }
 
@@ -55,7 +69,7 @@ public static function parse($input): ?self
             return null;
         }
 
-        return new self($input->id, $input->name, $input->description, $input->type);
+        return new self($input->id, $input->name, $input->description, $input->type, $input->architecture ?? null, $input->deprecated ?? null);
     }
 
     public function reload()