get ip addresses assigned to a nic

Author: Paul McNally

src/eCloud/Client.php

@@ -343,4 +343,12 @@ public function vips()
     {
         return (new VipClient($this->httpClient))->auth($this->token);
     }
+
+    /**
+     * @return BaseClient
+     */
+    public function nics()
+    {
+        return (new NicClient($this->httpClient))->auth($this->token);
+    }
 }

src/eCloud/Entities/Nic.php

@@ -6,10 +6,12 @@
 
 /**
  * @property string $id
+ * @property string $name
  * @property string $ipAddress
  * @property string $macAddress
  * @property string $instanceId
  * @property string $networkId
+ * @property string $sync
  */
 class Nic extends Entity
 {

src/eCloud/NicClient.php

@@ -4,17 +4,24 @@
 
 use UKFast\SDK\Entities\ClientEntityInterface;
 use UKFast\SDK\eCloud\Entities\Nic;
+use UKFast\SDK\Traits\PageItems;
 
 class NicClient extends Client implements ClientEntityInterface
 {
+    use PageItems;
+
+    protected $collectionPath = 'v2/nics';
+
     public function getEntityMap()
     {
         return [
             'id' => 'id',
-            'ip_address' => 'ipAddress',
+            'name' => 'name',
             'mac_address' => 'macAddress',
             'instance_id' => 'instanceId',
             'network_id' => 'networkId',
+            'ip_address' => 'ipAddress',
+            'sync' => 'sync',
             'created_at' => 'createdAt',
             'updated_at' => 'updatedAt',
         ];
@@ -26,4 +33,36 @@ public function loadEntity($data)
             $this->apiToFriendly($data, $this->getEntityMap())
         );
     }
+
+    /**
+     * Get the IP address records associated with a NIC
+     * @param $id
+     * @return array
+     */
+    public function getIpAddresses($id)
+    {
+        $page = $this->paginatedRequest(
+            $this->collectionPath . '/' . $id . '/ip-addresses',
+            $currentPage = 1,
+            $perPage = 15
+        );
+
+        if ($page->totalItems() == 0) {
+            return [];
+        }
+
+        $items = $page->getItems();
+        if ($page->totalPages() == 1) {
+            return $items;
+        }
+
+        while ($page->pageNumber() < $page->totalPages()) {
+            $page = $this->getPage($page->pageNumber() + 1, $perPage);
+            $items = array_merge(
+                $items,
+                $page->getItems()
+            );
+        }
+        return $items;
+    }
 }