Merge pull request #8 from truehostcloud/manage_domain_ns

retrieve and update domain nameservers

Author: willymwai

olittwhmcs/serializer.py

@@ -198,18 +198,57 @@ def order_domain_request_parameters(client_id, domain, payment_method,
 
 def order_bulk_products_request_parameters(parameters, **kwargs):
     """
-    Retrieve parameters for the domain order request.
-    :param parameters: dict of the order placed.
-    :param kwargs: (Optional) Other parameters to add to the order payload.
-        Eg promo_code, affiliate_id, price (override), ...
-    :return: payload for the order product request
-    :rtype: Dictionary
+        Retrieve parameters for the domain order request.
+        :param parameters: dict of the order placed.
+        :param kwargs: (Optional) Other parameters to add to the order payload.
+            Eg promo_code, affiliate_id, price (override), ...
+        :return: payload for the order product request
+        :rtype: Dictionary
+    """
+    default_parameters = get_default_parameters()
+    parameters.update(default_parameters)
+    return parameters
+
+
+def get_domain_nameservers_request_parameter(domain_id):
+    """
+       Retrieve parameters for geting domain nameservers request.
+       :param domain_id: ID of the domain.
+       :return: payload for geting domain nameservers request
+       :rtype: Dictionary
     """
-    default_parameters  = get_default_parameters()
-    parameters.update(default_parameters )
+    parameters = get_default_parameters()
+    parameters.update({
+        'action': 'DomainGetNameservers',
+        'domainid': str(domain_id)
+    })
     return parameters
 
 
+def update_domain_nameservers_request_parameter(parameters):
+    """
+      Retrieve parameters for updating domain nameservers.
+      :param parameters: Dict of the domain nameservers.
+      :return: payload for updating domain nameservers request
+      :rtype: Dictionary
+    """
+    updated_parameters = get_default_parameters()
+    updated_parameters.update({
+        'action': 'DomainUpdateNameservers',
+    })
+    param_map = {
+        "nameserver1": "ns1",
+        "nameserver2": "ns2",
+        "nameserver3": "ns3",
+        "nameserver4": "ns4",
+        "nameserver5": "ns5",
+        "domainid": "domainid",
+    }
+    for param, value in parameters.items():
+        updated_parameters.update({param_map[param]: value})
+    return updated_parameters
+
+
 def upgrade_product_request_parameters(service_id, payment_method, billing_cycle=None,
                                        package_id=None):
     """Retrieve parameters for the product upgrade request.

olittwhmcs/whmcs.py

@@ -14,7 +14,8 @@
     create_user_request_parameters, get_client_product_request_parameters, \
     upgrade_product_request_parameters, prepare_get_invoices_request, \
     prepare_get_orders_request, prepare_cancel_order_request, \
-    order_domain_request_parameters, order_bulk_products_request_parameters
+    order_domain_request_parameters, order_bulk_products_request_parameters, get_domain_nameservers_request_parameter, \
+    update_domain_nameservers_request_parameter
 
 
 ##########
@@ -199,6 +200,42 @@ def order_bulk_products(parameters=None, **kwargs):
     raise WhmcsException(response_or_error if response_or_error else default_error)
 
 
+def get_domain_nameservers(domain_id):
+    """get  domain nameservers.
+
+       Args:
+           domain_id (int): The Id of the domain.
+       Returns:
+           dict: the nameservers of the domain
+       Raises:
+           WhmcsException: If an error occurs.
+   """
+    parameters = get_domain_nameservers_request_parameter(domain_id)
+    is_successful, response_or_error = get_whmcs_response(parameters)
+    if is_successful and response_or_error:
+        return response_or_error
+    default_error = "Unable to get nameservers"
+    raise WhmcsException(response_or_error if response_or_error else default_error)
+
+
+def update_domain_nameservers(data):
+    """update a domain nameservers.
+
+        Args:
+            data (dict): data containing the nameservers and domain id.
+        Returns:
+            dict: the results of the update of nameserver
+        Raises:
+            WhmcsException: If an error occurs.
+    """
+    parameters = update_domain_nameservers_request_parameter(data)
+    is_successful, response_or_error = get_whmcs_response(parameters)
+    if is_successful and response_or_error:
+        return response_or_error
+    default_error = "Unable to update nameservers"
+    raise WhmcsException(response_or_error if response_or_error else default_error)
+
+
 def upgrade_client_product(service_id, payment_method, billing_cycle=None,
                            package_id=None):
     """Upgrade a product in WHMCS.