pyGuardPoint 2.0.1__tar.gz → 2.0.2__tar.gz

{pyguardpoint-2.0.1 → pyguardpoint-2.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyGuardPoint
-Version: 2.0.1
+Version: 2.0.2
 Summary: Python wrapper for GuardPoint 10 Access Control System
 Author: John Owen
 Maintainer-email: sales@sensoraccess.co.uk

{pyguardpoint-2.0.1 → pyguardpoint-2.0.2}/pyGuardPoint/_guardpoint_customizedfields.py

@@ -1,7 +1,7 @@
 import validators
 from .guardpoint_utils import GuardPointResponse
 from .guardpoint_error import GuardPointError, GuardPointUnauthorized
-from .guardpoint_dataclasses import CardholderCustomizedField
+from .guardpoint_dataclasses import CardholderCustomizedField, CustomizedField
 
 
 class CustomizedFieldsAPI:
@@ -14,6 +14,38 @@ class CustomizedFieldsAPI:
         Updates the custom fields for a specified cardholder.
     """
 
+    def get_custom_fields(self):
+        url = "/odata/API_CustomizedFields"
+        headers = {
+            'Content-Type': 'application/json',
+            'Accept': 'application/json'
+        }
+
+        code, json_body = self.gp_json_query("GET", headers=headers, url=url)
+
+        if code != 200:
+            error_msg = GuardPointResponse.extract_error_msg(json_body)
+
+            if code == 401:
+                raise GuardPointUnauthorized(f"Unauthorized - ({error_msg})")
+            elif code == 404:  # Not Found
+                raise GuardPointError(f"CustomizedFields Not Found")
+            else:
+                raise GuardPointError(f"{error_msg}")
+
+        if not isinstance(json_body, dict):
+            raise GuardPointError("Badly formatted response.")
+        if 'value' not in json_body:
+            raise GuardPointError("Badly formatted response.")
+        if not isinstance(json_body['value'], list):
+            raise GuardPointError("Badly formatted response.")
+
+        customizedFields = []
+        for x in json_body['value']:
+            customizedFields.append(CustomizedField(x))
+        return customizedFields
+
+
     def update_custom_fields(self, cardholder_uid: str, customFields: CardholderCustomizedField):
         """
         Update custom fields for a specific cardholder.
@@ -36,7 +68,7 @@ class CustomizedFieldsAPI:
         if not validators.uuid(cardholder_uid):
             raise ValueError(f'Malformed Cardholder UID {cardholder_uid}')
 
-        url = "/odata/API_CardholderCustomizedFields"
+        url = "/odata/API_CustomizedFields"
         url_query_params = f"({cardholder_uid})"
 
         headers = {

pyguardpoint-2.0.2/pyGuardPoint/gp_asyncio/_async_guardpoint_customizedfields.py

@@ -0,0 +1,67 @@
+import validators
+from ..guardpoint_utils import GuardPointResponse
+from ..guardpoint_error import GuardPointError, GuardPointUnauthorized
+from ..guardpoint_dataclasses import CardholderCustomizedField, CustomizedField
+
+
+class CustomizedFieldsAPI:
+
+    async def get_custom_fields(self):
+        url = "/odata/API_CustomizedFields"
+        headers = {
+            'Content-Type': 'application/json',
+            'Accept': 'application/json'
+        }
+
+        code, json_body = await self.gp_json_query("GET", headers=headers, url=url)
+
+        if code != 200:
+            error_msg = GuardPointResponse.extract_error_msg(json_body)
+
+            if code == 401:
+                raise GuardPointUnauthorized(f"Unauthorized - ({error_msg})")
+            elif code == 404:  # Not Found
+                raise GuardPointError(f"CustomizedFields Not Found")
+            else:
+                raise GuardPointError(f"{error_msg}")
+
+        if not isinstance(json_body, dict):
+            raise GuardPointError("Badly formatted response.")
+        if 'value' not in json_body:
+            raise GuardPointError("Badly formatted response.")
+        if not isinstance(json_body['value'], list):
+            raise GuardPointError("Badly formatted response.")
+
+        customizedFields = []
+        for x in json_body['value']:
+            customizedFields.append(CustomizedField(x))
+        return customizedFields
+
+    async def update_custom_fields(self, cardholder_uid: str, customFields: CardholderCustomizedField):
+        if not validators.uuid(cardholder_uid):
+            raise ValueError(f'Malformed Cardholder UID {cardholder_uid}')
+
+        url = "/odata/API_CardholderCustomizedFields"
+        url_query_params = f"({cardholder_uid})"
+
+        headers = {
+            'Content-Type': 'application/json',
+            'Accept': 'application/json',
+            # 'IgnoreNonEditable': ''
+        }
+
+        ch = customFields.dict(changed_only=True)
+
+        code, json_body = await self.gp_json_query("PATCH", headers=headers, url=(url + url_query_params), json_body=ch)
+
+        if code != 204:  # HTTP NO_CONTENT
+            error_msg = GuardPointResponse.extract_error_msg(json_body)
+
+            if code == 401:
+                raise GuardPointUnauthorized(f"Unauthorized - ({error_msg})")
+            elif code == 404:  # Not Found
+                raise GuardPointError(f"Cardholder Not Found")
+            else:
+                raise GuardPointError(f"{error_msg}")
+
+        return True

{pyguardpoint-2.0.1 → pyguardpoint-2.0.2}/pyGuardPoint/guardpoint_dataclasses.py

@@ -62,6 +62,41 @@ class CardholderOrderBy(Enum):
     fromDateValid_DESC = 0,
     lastPassDate_DESC = 1
 
+@dataclass
+class CustomizedField:
+    customizedFieldType: str = ""
+    description: str = ""
+    cardholderCFName: str = ""
+    name: str = ""
+    uid: str = ""
+    booleanDefaultValue: any = None
+    dateTimeDefaultValue: any = None
+    fromValue: any = None
+    toValue: any = None
+    numberDefaultValue: any = None
+    minValue: any = None
+    maxValue: any = None
+    stringDefaultValue: str = ""
+    isMultiLine: any = None
+
+    def __init__(self, *args, **kwargs):
+        super().__init__()
+        cf_dict = sanitise_args(self, args, kwargs)
+
+        for property_name in cf_dict:
+            if isinstance(cf_dict[property_name], (str, type(None), bool, int, dict)):
+                setattr(self, property_name, cf_dict[property_name])
+
+    def dict(self):
+        cf_dict = {}
+        for k, v in asdict(self).items():
+            if isinstance(v, (list, dict, bool, int)):
+                cf_dict[k] = v
+            elif isinstance(v, type(None)):
+                cf_dict[k] = None
+            else:
+                cf_dict[k] = str(v)
+
 @dataclass
 class ManualEvent:
     uid: str = ""

{pyguardpoint-2.0.1 → pyguardpoint-2.0.2}/pyGuardPoint.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyGuardPoint
-Version: 2.0.1
+Version: 2.0.2
 Summary: Python wrapper for GuardPoint 10 Access Control System
 Author: John Owen
 Maintainer-email: sales@sensoraccess.co.uk

{pyguardpoint-2.0.1 → pyguardpoint-2.0.2}/setup.py

@@ -5,7 +5,7 @@ long_description = open('README.rst').read()
 setup(name="pyGuardPoint",
       python_requires='>3.9.0',
       packages=find_packages(),
-      version="2.0.1",
+      version="2.0.2",
       author="John Owen",
       description="Python wrapper for GuardPoint 10 Access Control System",
       long_description_content_type='text/markdown',

pyguardpoint-2.0.1/pyGuardPoint/gp_asyncio/_async_guardpoint_customizedfields.py

@@ -1,36 +0,0 @@
-import validators
-from ..guardpoint_utils import GuardPointResponse
-from ..guardpoint_error import GuardPointError, GuardPointUnauthorized
-from ..guardpoint_dataclasses import CardholderCustomizedField
-
-
-class CustomizedFieldsAPI:
-
-    async def update_custom_fields(self, cardholder_uid: str, customFields: CardholderCustomizedField):
-        if not validators.uuid(cardholder_uid):
-            raise ValueError(f'Malformed Cardholder UID {cardholder_uid}')
-
-        url = "/odata/API_CardholderCustomizedFields"
-        url_query_params = f"({cardholder_uid})"
-
-        headers = {
-            'Content-Type': 'application/json',
-            'Accept': 'application/json',
-            # 'IgnoreNonEditable': ''
-        }
-
-        ch = customFields.dict(changed_only=True)
-
-        code, json_body = await self.gp_json_query("PATCH", headers=headers, url=(url + url_query_params), json_body=ch)
-
-        if code != 204:  # HTTP NO_CONTENT
-            error_msg = GuardPointResponse.extract_error_msg(json_body)
-
-            if code == 401:
-                raise GuardPointUnauthorized(f"Unauthorized - ({error_msg})")
-            elif code == 404:  # Not Found
-                raise GuardPointError(f"Cardholder Not Found")
-            else:
-                raise GuardPointError(f"{error_msg}")
-
-        return True