Add TerminalVerb Class

Author: ajrice6713

bandwidth/model/bxml/terminal_verb.py

@@ -0,0 +1,35 @@
+"""
+verb.py
+
+Defines the base verb class for all BXML verbs
+
+@copyright Bandwidth INC
+"""
+from .verb import Verb
+
+
+class TerminalVerb(Verb):
+    """Base class for BXML verbs
+    """
+
+    def __init__(self, tag: str, content: str = None, attributes: dict = None, nested_verbs: list[Verb] = None):
+        """Initialize the verb model
+
+        Args:
+            tag (str): Name of the XML element
+            content (str, optional): XML element content. Defaults to None.
+            attributes (dict, optional): XML element attributes. Defaults to None.
+            nested_verbs (list[BxmlVerb], optional): XML element children. Defaults to None.
+        """
+        super().__init__(tag=tag, content=content, attributes=attributes, nested_verbs=nested_verbs)
+
+    def add_verb(self, verb: Verb):
+        """Adding verbs is not allowed for this class
+
+        Args:
+            verb (Verb): BXML verb
+
+        Raises:
+            AttributeError: This method is not allowed for <SipUri>
+        """
+        raise AttributeError('Adding verbs is not supported by this verb')

bandwidth/model/bxml/verb.py

@@ -13,7 +13,7 @@ class Verb:
     """Base class for BXML verbs
     """
 
-    def __init__(self, tag: str, content: str = None, attributes: dict = None, nested_verbs: list[BxmlVerb] = None):
+    def __init__(self, tag: str, content: str = None, attributes: dict = None, nested_verbs: list[Verb] = None):
         """Initialize the verb model
 
         Args:
@@ -36,18 +36,18 @@ def __len__(self) -> int:
             int: Length of self._nested_verbs
         """
         return len(self._nested_verbs)
-    
+
     def __getitem__(self, position) -> Verb:
         """Override default getitem method. Makes the object iterable.
 
         Args:
             position (int): Desired self._nested_verbs list position
 
         Returns:
-            BxmlVerb: Desired BXML verb 
+            BxmlVerb: Desired BXML verb
         """
         return self._nested_verbs[position]
-    
+
     def _set_attributes(self, root: ET.Element):
         """Set XML attributes on an Element
 

bandwidth/model/bxml/verbs/bridge.py

@@ -5,10 +5,10 @@
 
 @copyright Bandwidth INC
 """
-from ..verb import Verb
+from ..terminal_verb import TerminalVerb
 
 
-class Bridge(Verb):
+class Bridge(TerminalVerb):
 
     def __init__(
         self, target_call: str, bridge_complete_url: str=None,
@@ -62,6 +62,3 @@ def __init__(
             attributes=self.attributes,
             nested_verbs=None
         )
-
-    def add_verb(self, verb: Verb):
-        raise AttributeError('Adding verbs is not supported by <Bridge>')

bandwidth/model/bxml/verbs/phone_number.py

@@ -5,10 +5,10 @@
 
 @copyright Bandwidth INC
 """
-from ..verb import Verb
+from ..terminal_verb import TerminalVerb
 
 
-class PhoneNumber(Verb):
+class PhoneNumber(TerminalVerb):
 
     def __init__(
         self, number: str, transfer_answer_url: str=None, transfer_answer_method: str=None,
@@ -48,17 +48,6 @@ def __init__(
         super().__init__(
             tag="PhoneNumber",
             content=number,
-            attributes=self.attributes, 
+            attributes=self.attributes,
             nested_verbs=None
         )
-    
-    def add_verb(self, verb: Verb):
-        """Adding verbs is not allowed for <PhoneNumber>
-
-        Args:
-            verb (Verb): BXML verb
-
-        Raises:
-            AttributeError: This method is not allowed for <PhoneNumber>
-        """
-        raise AttributeError('Adding verbs is not supported by <PhoneNumber>')

bandwidth/model/bxml/verbs/sip_uri.py

@@ -5,10 +5,10 @@
 
 @copyright Bandwidth INC
 """
-from ..verb import Verb
+from ..terminal_verb import TerminalVerb
 
 
-class SipUri(Verb):
+class SipUri(TerminalVerb):
 
     def __init__(
         self, uri: str, uui: str=None, transfer_answer_url: str=None, transfer_answer_method: str=None,
@@ -50,17 +50,6 @@ def __init__(
         super().__init__(
             tag="SipUri",
             content=uri,
-            attributes=self.attributes, 
+            attributes=self.attributes,
             nested_verbs=None
         )
-    
-    def add_verb(self, verb: Verb):
-        """Adding verbs is not allowed for <SipUri>
-
-        Args:
-            verb (Verb): BXML verb
-
-        Raises:
-            AttributeError: This method is not allowed for <SipUri>
-        """
-        raise AttributeError('Adding verbs is not supported by <SipUri>')

bandwidth/model/bxml/verbs/tag.py

@@ -5,10 +5,10 @@
 
 @copyright Bandwidth INC
 """
-from ..verb import Verb
+from ..terminal_verb import TerminalVerb
 
 
-class Tag(Verb):
+class Tag(TerminalVerb):
 
     def __init__(self, content=""):
         """Initialize a <Tag> verb
@@ -17,14 +17,3 @@ def __init__(self, content=""):
             content (str, optional): Custom tag value. Defaults to "".
         """
         super().__init__(tag="Tag", content=content, attributes=None, nested_verbs=None)
-    
-    def add_verb(self, verb: Verb):
-        """Adding verbs is not allowed for <Tag>
-
-        Args:
-            verb (Verb): BXML verb
-
-        Raises:
-            AttributeError: This method is not allowed for <Tag>
-        """
-        raise AttributeError('Adding verbs is not supported by <Tag>')