Add child typing to all other existing message types

mitel_ommclient2/client.py

@@ -102,7 +102,7 @@ class OMMClient2:
                 yield pp
 
             # Determine next possible ppn
-            next_ppn = int(pp["ppn"]) + 1
+            next_ppn = int(pp.ppn) + 1
 
     def get_user(self, uid):
         """

mitel_ommclient2/messages/getaccount.py

@@ -1,6 +1,7 @@
 #!/usr/bin/env python3
 
 from . import Request, Response, request_type, response_type
+from ..types import AccountType
 
 
 @request_type
@@ -14,5 +15,5 @@ class GetAccount(Request):
 @response_type
 class GetAccountResp(Response):
     CHILDS = {
-        "account": None,
+        "account": AccountType,
     }

mitel_ommclient2/messages/getppdev.py

@@ -1,6 +1,7 @@
 #!/usr/bin/env python3
 
 from . import Request, Response, request_type, response_type
+from ..types import PPDevType
 
 
 @request_type
@@ -14,5 +15,5 @@ class GetPPDev(Request):
 @response_type
 class GetPPDevResp(Response):
     CHILDS = {
-        "pp": None,
+        "pp": PPDevType,
     }

mitel_ommclient2/types/__init__.py

@@ -11,12 +11,15 @@ class ChildType:
 
     FIELDS = {}
 
-
     def __init__(self, attrs={}):
         self._attrs = {}
 
-        for k, v in attrs.items():
-            setattr(self, k, v)
+        if self.FIELDS is not None:
+            for k, v in attrs.items():
+                setattr(self, k, v)
+        else:
+            # don't check attrs for types we do have any information
+            self._attrs = attrs
 
     def __getattr__(self, name):
         if name in self.FIELDS.keys():
@@ -45,11 +48,97 @@ def cast_dict_to_childtype(t, d):
 
     return t(d)
 
+
+class EnumType:
+
+    VALUES = [] # Allowed values
+
+    def __init__(self, s):
+        if self.VALUES is not None:
+            if s in self.VALUES:
+                self.value = s
+            else:
+                raise ValueError()
+        else:
+            self.value = s
+
+    def __str__(self):
+        return str(self.value)
+
+    def __repr__(self):
+        return "{}({})".format(self.__class__.__name__, repr(self.value))
+
+
+class CallForwardStateType(EnumType):
+    VALUES = [
+        "Off",
+        "Busy",
+        "NoAnswer",
+        "BusyNoAnswer",
+        "All",
+    ]
+
+
+class DECTSubscriptionStateType(EnumType):
+    VALUES = None
+
+
+class LanguageType(EnumType):
+    VALUES = None
+
+
+class MonitoringStateType(EnumType):
+    VALUES = None
+
+
+class PPRelTypeType(EnumType):
+    VALUES = None
+
+
+class AccountType(ChildType):
+    FIELDS = {
+        "id": int,
+        "username": str,
+        "password": str,
+        "oldPassword": str,
+        "permission": None,
+        "active": bool,
+        "aging": None,
+        "expire": int,
+        "state": str,
+    }
+
+
+class PPDevType(ChildType):
+    FIELDS = {
+        "ppn": int,
+        "timeStamp": int,
+        "relType": PPRelTypeType,
+        "uid": int,
+        "ipei": str,
+        "ac": str,
+        "s": DECTSubscriptionStateType,
+        "uak": str,
+        "encrypt": bool,
+        "capMessaging": bool,
+        "capMessagingForInternalUse": bool,
+        "capEnhLocating": bool,
+        "capBluetooth": bool,
+        "ethAddr": str,
+        "hwType": str,
+        "ppProfileCapability": bool,
+        "ppDefaultProfileLoaded": bool,
+        "subscribeToPARIOnly": bool,
+        # undocumented
+        "ppnSec": int,
+    }
+
+
 class PPUserType(ChildType):
     FIELDS = {
         "uid": int,
         "timeStamp": int,
-        "relType": None, #PPRelTypeType,
+        "relType": PPRelTypeType,
         "ppn": int,
         "name": str,
         "num": str,
@@ -62,10 +151,10 @@ class PPUserType(ChildType):
         "sosNum": str,
         "voiceboxNum": str,
         "manDownNum": str,
-        "forwardStateCall": None, #ForwardStateType,
+        "forwardState": CallForwardStateType,
         "forwardTime": int,
         "forwardDest": str,
-        "langPP": None, #LanguageType,
+        "langPP": LanguageType,
         "holdRingBackTime": int,
         "autoAnswer": str,
         "microphoneMute": str,
@@ -88,17 +177,17 @@ class PPUserType(ChildType):
         "conferenceServerType": str,
         "conferenceServerURI": str,
         "monitoringMode": str,
-        "CUS": None, #MonitoringStateType,
-        "HAS": None, #MonitoringStateType,
-        "HSS": None, #MonitoringStateType,
-        "HRS": None, #MonitoringStateType,
-        "HCS": None, #MonitoringStateType,
-        "SRS": None, #MonitoringStateType,
-        "SCS": None, #MonitoringStateType,
-        "CDS": None, #MonitoringStateType,
-        "HBS": None, #MonitoringStateType,
-        "BTS": None, #MonitoringStateType,
-        "SWS": None, #MonitoringStateType,
+        "CUS": MonitoringStateType,
+        "HAS": MonitoringStateType,
+        "HSS": MonitoringStateType,
+        "HRS": MonitoringStateType,
+        "HCS": MonitoringStateType,
+        "SRS": MonitoringStateType,
+        "SCS": MonitoringStateType,
+        "CDS": MonitoringStateType,
+        "HBS": MonitoringStateType,
+        "BTS": MonitoringStateType,
+        "SWS": MonitoringStateType,
         "credentialPw": str,
         "configurationDataLoaded": bool,
         "ppData": str,
@@ -109,7 +198,6 @@ class PPUserType(ChildType):
         "uidSec": int,
         "permanent": bool,
         "lang": None,
-        "forwardState": None,
         "autoLogoutOnCharge": bool,
         "hotDeskingSupport": bool,
         "authenticateLogout": bool,