added RD pool functionality

Author: sbarbett

.plugin-version

@@ -1 +1 @@
-v2.2.4
+v2.2.5

README.md

@@ -200,6 +200,26 @@ def create_cname_record(client, domain):
     """
     return client.create_rrset(domain, "CNAME", f"www.{domain}", 300, [domain])
 
+def create_rd_pool(client, domain):
+    """Create a pool of A records in UltraDNS. This function will create an RD pool within the specified domain.
+
+    Args:
+    - client (RestApiClient): An instance of the RestApiClient class.
+    - domain (str): The domain name.
+
+    Returns:
+    - dict: The response body.
+    """
+    return client.create_rd_pool(
+        domain, 
+        "pool",
+        300,
+        [
+            "192.0.2.2",
+            "192.0.2.3"
+        ]
+    )
+
 def delete_zone(client, domain):
     """Delete the zone from UltraDNS.
 

src/ultra_rest_client/about.py

@@ -1,4 +1,4 @@
-__version__ = "2.2.4"
+__version__ = "0.0.0"
 PREFIX = "udns-python-rest-client-"
 
 def get_client_user_agent():

src/ultra_rest_client/ultra_rest_client.py

@@ -599,6 +599,109 @@ def batch(self, batch_list):
         """
         return self.rest_api_connection.post("/v1/batch", json.dumps(batch_list))
 
+    # Create an RD Pool
+    # Sample JSON for an RD pool -- see the REST API docs for their descriptions
+    # {
+    #     "ttl": 120,
+    #     "rdata": [
+    #         "4.5.6.7", "199.7.167.22", "1.2.3.4", "5.6.7.8"
+    #     ],
+    #     "profile": {
+    #         "@context": "http://schemas.ultradns.com/RDPool.jsonschema",
+    #         "description": "description",
+    #         "order": "ROUND_ROBIN"
+    #     }
+    # }
+
+    def _build_rd_rrset(self, rdata_info, ttl, owner_name, order, description):
+        """Builds an RD Pool RRSet.
+        
+        :param rdata_info: List of record data for the records in the pool.
+        :param ttl: The TTL value for the RRSet.
+        :param owner_name: The owner name for the RRSet.
+        :param order: The order in which rdata is served. Used for RD pools.
+        :param description: A description for the RD pool. Defaults to owner_name if not provided.
+        :return: A dictionary representing the RRSet.
+        """
+        profile = {
+            "@context": "http://schemas.ultradns.com/RDPool.jsonschema",
+            "order": order,
+            "description": description if description is not None else owner_name
+        }
+        
+        return {"ttl": ttl, "rdata": rdata_info, "profile": profile}
+
+    def create_rd_pool(self, zone_name, owner_name, ttl, rdata_info, order="ROUND_ROBIN", ipv6=False, description=None):
+        """Creates a new RD Pool.
+        
+        :param zone_name: The zone that contains the RRSet. The trailing dot is optional.
+        :param owner_name: The owner name for the RRSet.
+                          If no trailing dot is supplied, the owner_name is assumed to be relative (foo).
+                          If a trailing dot is supplied, the owner name is assumed to be absolute (foo.zonename.com.)
+        :param ttl: The TTL value for the RRSet.
+        :param rdata_info: List of record data for the records in the pool.
+                           Values are strings representing either IPv4 or IPv6 addresses.
+        :param order: (Optional) The order in which rdata is served. Default is ROUND_ROBIN.
+                      Valid options:
+                        - ROUND_ROBIN
+                        - FIXED
+                        - RANDOM
+        :param ipv6: (Optional) Boolean indicating whether to create an AAAA (True) or A (False) RD pool. Default is False.
+        :param description: (Optional) A description for the RD pool. Defaults to owner_name if not provided.
+        :return: API response from the POST request.
+        """
+        rtype = "AAAA" if ipv6 else "A"
+        rrset = self._build_rd_rrset(rdata_info, ttl, owner_name, order, description)
+        return self.rest_api_connection.post(
+            f"/v1/zones/{zone_name}/rrsets/{rtype}/{owner_name}",
+            json.dumps(rrset)
+        )
+
+    def edit_rd_pool(self, zone_name, owner_name, ttl, rdata_info, order="ROUND_ROBIN", ipv6=False, description=None):
+        """Updates an existing RD Pool in the specified zone.
+        
+        :param zone_name: The zone that contains the RRSet. The trailing dot is optional.
+        :param owner_name: The owner name for the RRSet.
+                          If no trailing dot is supplied, the owner_name is assumed to be relative (foo).
+                          If a trailing dot is supplied, the owner name is assumed to be absolute (foo.zonename.com.)
+        :param ttl: The TTL value for the RRSet.
+        :param rdata_info: List of record data for the records in the pool.
+        :param order: (Optional) The order in which rdata is served. Default is ROUND_ROBIN.
+        :param ipv6: (Optional) Boolean indicating whether to create an AAAA (True) or A (False) RD pool. Default is False.
+        :param description: (Optional) A description for the RD pool. Defaults to owner_name if not provided.
+        :return: API response from the PUT request.
+        """
+        rtype = "AAAA" if ipv6 else "A"
+        rrset = self._build_rd_rrset(rdata_info, ttl, owner_name, order, description)
+        return self.rest_api_connection.put(
+            f"/v1/zones/{zone_name}/rrsets/{rtype}/{owner_name}",
+            json.dumps(rrset)
+        )
+
+    def get_rd_pools(self, zone_name):
+        """Retrieves an RD Pool in the specified zone.
+        
+        :param zone_name: The zone that contains the RRSet.
+        :param owner_name: The owner name for the RRSet.
+        :return: API response from the GET request.
+        """
+        return self.rest_api_connection.get(
+            f"/v1/zones/{zone_name}/rrsets?q=kind:RD_POOLS"
+        )
+
+    def delete_rd_pool(self, zone_name, owner_name, ipv6=False):
+        """Deletes an RD Pool in the specified zone.
+        
+        :param zone_name: The zone that contains the RRSet.
+        :param owner_name: The owner name for the RRSet.
+        :param ipv6: (Optional) Boolean indicating whether to delete an AAAA (True) or A (False) RD pool. Default is False.
+        :return: API response from the DELETE request.
+        """
+        rtype = "AAAA" if ipv6 else "A"
+        return self.rest_api_connection.delete(
+            f"/v1/zones/{zone_name}/rrsets/{rtype}/{owner_name}"
+        )
+
     # Create an SB Pool
     # Sample JSON for an SB pool -- see the REST API docs for their descriptions
     # {