Merge pull request #428 from markkuleinio/add-available-vlans

Fixes #427: Adds support for `available-vlans` child endpoint for VLAN groups

Author: zachmoody

docs/IPAM.rst

@@ -2,4 +2,7 @@ IPAM
 ========
 
 .. autoclass:: pynetbox.models.ipam.Prefixes
-  :members:
+  :members:
+
+.. autoclass:: pynetbox.models.ipam.VlanGroups
+  :members:

pynetbox/models/ipam.py

@@ -97,3 +97,34 @@ def available_prefixes(self):
 class Aggregates(Record):
     def __str__(self):
         return str(self.prefix)
+
+
+class Vlans(Record):
+    def __str__(self):
+        return super().__str__(self) or str(self.vid)
+
+
+class VlanGroups(Record):
+    @property
+    def available_vlans(self):
+        """ Represents the ``available-vlans`` detail endpoint.
+
+        Returns a DetailEndpoint object that is the interface for
+        viewing and creating VLANs inside a VLAN group.
+
+        Available since NetBox 3.2.0.
+
+        :returns: :py:class:`.DetailEndpoint`
+
+        :Examples:
+
+        >>> vlan_group = nb.ipam.vlan_groups.get(1)
+        >>> vlan_group.available_vlans.list()
+        [10, 11, 12]
+
+        To create a new VLAN:
+
+        >>> vlan_group.available_vlans.create({"name": "NewVLAN"})
+        NewVLAN (10)
+        """
+        return DetailEndpoint(self, "available-vlans", custom_return=Vlans)