Add sites, and add integration of IPtrunks and routers with LSO deployment

gso/services/provisioning_proxy.py

-import enum
 import json
 import logging
 
 import requests
 from orchestrator import inputstep
 from orchestrator.config.assignee import Assignee
-from orchestrator.domain.lifecycle import SubscriptionModel
 from orchestrator.forms import FormPage, ReadOnlyField
 from orchestrator.forms.validators import Accept, Label, LongText
-from orchestrator.types import UUIDstr, State
+from orchestrator.types import UUIDstr, State, strEnum
 from orchestrator.utils.json import json_dumps
 
 from gso import settings
+from gso.products.product_types.device import DeviceProvisioning
 from gso.products.product_types.iptrunk import IptrunkProvisioning, Iptrunk
 
 logger = logging.getLogger(__name__)
 
 
-class CUDOperation(str, enum.Enum):
+class CUDOperation(strEnum):
     """
     Enum for different C(R)UD operations that the provisioning proxy supports.
     Read is not applicable, hence these become CUD and not CRUD operations.
@@ -32,6 +31,20 @@ class CUDOperation(str, enum.Enum):
 
 def _send_request(endpoint: str, parameters: dict, process_id: UUIDstr,
                   operation: CUDOperation):
+    """
+    Internal function for sending a request to LSO. The callback address is
+    derived using the process ID provided.
+
+    :param str endpoint: The LSO-specific endpoint to call, depending on the
+        type of service object that is acted upon.
+    :param dict parameters: JSON body for the request, which will almost always
+        at least consist of a subscription object, and a boolean value to
+        indicate a dry run.
+    :param UUIDstr process_id: The process ID that this request is a part of,
+        used to call back to when the execution of the playbook is completed.
+    :param :class:`CUDOperation` operation: The specific operation that is
+        performed with the request.
+    """
     oss = settings.load_oss_params()
     pp_params = oss.PROVISIONING_PROXY
     assert pp_params
@@ -57,9 +70,18 @@ def _send_request(endpoint: str, parameters: dict, process_id: UUIDstr,
 
 
 def provision_device(
-        subscription: SubscriptionModel,
+        subscription: DeviceProvisioning,
         process_id: UUIDstr,
         dry_run: bool = True):
+    """
+    Function that provisions a new device using LSO.
+
+    :param :class:`DeviceProvisioning` subscription: The subscription object
+        that is to be provisioned.
+    :param UUIDstr process_id: The related process ID, used for callback.
+    :param bool dry_run: A boolean indicating whether this should be a dry run
+        or not, defaults to ``True``.
+    """
     parameters = {
         'dry_run': dry_run,
         'subscription': json.loads(json_dumps(subscription))
@@ -71,6 +93,15 @@ def provision_device(
 def provision_ip_trunk(subscription: IptrunkProvisioning,
                        process_id: UUIDstr,
                        dry_run: bool = True):
+    """
+    Function that provisions an IP trunk service using LSO.
+
+    :param :class:`IptrunkProvisioning` subscription: The subscription object
+        that is to be provisioned.
+    :param UUIDstr process_id: The related process ID, used for callback.
+    :param bool dry_run: A boolean indicating whether this should be a dry run
+        or not, defaults to ``True``.
+    """
     parameters = {
         'subscription': json.loads(json_dumps(subscription)),
         'dry_run': dry_run,
@@ -85,6 +116,17 @@ def modify_ip_trunk(old_subscription: Iptrunk,
                     new_subscription: Iptrunk,
                     process_id: UUIDstr,
                     dry_run: bool = True):
+    """
+    Function that modifies an existing IP trunk subscription using LSO.
+
+    :param :class:`Iptrunk` old_subscription: The subscription object, before
+        its modification.
+    :param :class:`Iptrunk` new_subscription: The subscription object, after
+        modifications have been made to it.
+    :param UUIDstr process_id: The related process ID, used for callback.
+    :param bool dry_run: A boolean indicating whether this should be a dry ryn
+        or not, defaults to ``True``.
+    """
     parameters = {
         'dry_run': dry_run,
         'old_subscription': old_subscription,