neris-api-client 1.3.5__tar.gz → 1.4.0__tar.gz

{neris_api_client-1.3.5/src/neris_api_client.egg-info → neris_api_client-1.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: neris_api_client
-Version: 1.3.5
+Version: 1.4.0
 Summary: NERIS API Client
 Author-email: Ben Coleman <ben.coleman@ul.org>, Tommy Messbauer <thomas.messbauer@ul.org>, Joseph Pagani <joseph.pagani@ul.org>
 Project-URL: Homepage, https://github.com/ulfsri/neris-api-client

{neris_api_client-1.3.5 → neris_api_client-1.4.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "neris_api_client"
-version = "1.3.5"
+version = "1.4.0"
 authors = [
   { name="Ben Coleman", email="ben.coleman@ul.org" },
   { name="Tommy Messbauer", email="thomas.messbauer@ul.org" },

{neris_api_client-1.3.5 → neris_api_client-1.4.0}/src/neris_api_client/client.py

@@ -2,7 +2,7 @@ import base64
 from http import HTTPStatus
 import json
 from uuid import UUID
-from typing import List, Optional, Dict, Any
+from typing import List, Optional, Dict, Any, Literal
 from datetime import datetime, timedelta
 
 import requests
@@ -13,13 +13,15 @@ from .config import Config, GrantType, TokenSet
 from .models import (
     IncidentPayload,
     PatchUnitPayload,
+    CreateUnitPayload,
     CreateUserPayload,
     DepartmentPayload,
     UpdateUserPayload,
+    PatchIncidentAction,
     PatchStationPayload,
+    CreateStationPayload,
     PatchDepartmentPayload,
     CreateDepartmentPayload,
-    PatchIncidentAction,
     TypeIncidentStatusValue,
 )
 
@@ -47,12 +49,14 @@ class _NerisApiClient:
             case GrantType.CLIENT_CREDENTIALS:
                 assert config.client_id is not None
                 assert config.client_secret is not None
-                self.client_creds = base64.b64encode(f"{config.client_id}:{config.client_secret}".encode("utf-8")).decode("utf-8")
+                self.client_creds = base64.b64encode(
+                    f"{config.client_id}:{config.client_secret}".encode("utf-8")
+                ).decode("utf-8")
             case GrantType.PASSWORD:
                 assert config.username is not None
                 assert config.password is not None
             case _:
-                raise Exception("Bad grant type. Must be \"password\" or \"client_credentials\"")
+                raise Exception('Bad grant type. Must be "password" or "client_credentials"')
 
         self.config = config
 
@@ -65,7 +69,7 @@ class _NerisApiClient:
                 case GrantType.PASSWORD:
                     res = self._session.post(
                         token_url,
-                        headers={'Content-Type': 'application/x-www-form-urlencoded'},
+                        headers={"Content-Type": "application/x-www-form-urlencoded"},
                         data={
                             "grant_type": GrantType.PASSWORD,
                             "username": self.config.username,
@@ -76,7 +80,10 @@ class _NerisApiClient:
                 case GrantType.CLIENT_CREDENTIALS:
                     res = self._session.post(
                         token_url,
-                        headers={"Authorization": f"Basic {self.client_creds}", "Content-Type": "application/x-www-form-urlencoded"},
+                        headers={
+                            "Authorization": f"Basic {self.client_creds}",
+                            "Content-Type": "application/x-www-form-urlencoded",
+                        },
                         data={"grant_type": GrantType.CLIENT_CREDENTIALS},
                     )
 
@@ -97,7 +104,10 @@ class _NerisApiClient:
                     res = self._session.post(
                         token_url,
                         # Basic auth required for NERIS refresh tokens
-                        headers={"Authorization": f"Basic {self.client_creds}", "Content-Type": "application/x-www-form-urlencoded"},
+                        headers={
+                            "Authorization": f"Basic {self.client_creds}",
+                            "Content-Type": "application/x-www-form-urlencoded",
+                        },
                         data={
                             "grant_type": "refresh_token",
                             "refresh_token": self.tokens.refresh_token,
@@ -141,13 +151,13 @@ class _NerisApiClient:
 
                 res = self._session.post(
                     token_url,
-                    headers={'Content-Type': 'application/x-www-form-urlencoded'},
+                    headers={"Content-Type": "application/x-www-form-urlencoded"},
                     data={
                         "grant_type": got["challenge_name"],
                         "username": self.config.username,
                         "session": got["session"],
                         got["challenge_name"]: code,
-                    }
+                    },
                 )
 
     def _call(
@@ -167,8 +177,9 @@ class _NerisApiClient:
             if isinstance(data, dict):
                 data = model.model_validate(data).model_dump(mode="json", by_alias=True)
 
-
-        res = getattr(self._session, method)(f"{self.config.base_url}{path}", json=data, params=params)
+        res = getattr(self._session, method)(
+            f"{self.config.base_url}{path}", json=data, params=params
+        )
 
         if self.config.debug:
             print(
@@ -180,12 +191,11 @@ class _NerisApiClient:
                             "headers": self._session.headers,
                             "params": params,
                         },
-
                         "response": {
                             "status_code": res.status_code,
                             "headers": res.headers,
                             "content": res.text,
-                        }
+                        },
                     },
                     indent=4,
                     cls=Encoder,
@@ -236,11 +246,17 @@ class NerisApiClient(_NerisApiClient):
     def delete_user(self, sub: str | UUID) -> None:
         self._call("delete", f"/user/{sub}")
 
-    def create_user_role_entity_set_attachment(self, sub_user: str | UUID, nuid_role: str | UUID, nuid_entity_set: str | UUID) -> Dict[str, Any]:
+    def create_user_role_entity_set_attachment(
+        self, sub_user: str | UUID, nuid_role: str | UUID, nuid_entity_set: str | UUID
+    ) -> Dict[str, Any]:
         return self._call(
             "post",
             "/auth/user_role_entity_set_attachment",
-            params={"sub_user": str(sub_user), "nuid_role": str(nuid_role), "nuid_entity_set": str(nuid_entity_set)},
+            params={
+                "sub_user": str(sub_user),
+                "nuid_role": str(nuid_role),
+                "nuid_entity_set": str(nuid_entity_set),
+            },
         )
 
     def create_user_entity_membership(self, sub: str | UUID, neris_id: str) -> None:
@@ -267,9 +283,54 @@ class NerisApiClient(_NerisApiClient):
             "post", f"/incident/{neris_id}/validate", data=body, model=IncidentPayload
         )
 
+    def list_incidents(
+        self,
+        *,
+        neris_id_entity: str | None = None,
+        incident_types: list[str] | None = None,
+        incident_types_set_operation: Literal["UNION", "INTERSECTION"] | None = None,
+        call_create_start: datetime | None = None,
+        call_create_end: datetime | None = None,
+        incident_number: str | None = None,
+        dispatch_incident_number: str | None = None,
+        status: list[Literal["APPROVED", "PENDING_APPROVAL", "REJECTED", "SUBMITTED"]] | None = None,
+        last_modified: str | None = None,
+        sort_by: Literal["call_create", "neris_id_entity", "incident_number", "dispatch_incident_number", "status", "last_modified"] | None = None,
+        sort_direction: Literal["ASCENDING", "DESCENDING"] | None = None,
+        page_size: int | None = None,
+        cursor: str | None = None,
+    ) -> dict[str, Any]:
+        params = dict(
+            neris_id_entity=neris_id_entity,
+            incident_types=incident_types,
+            incident_types_set_operation=incident_types_set_operation,
+            call_create_start=call_create_start and call_create_start.isoformat(),
+            call_create_end=call_create_end and call_create_end.isoformat(),
+            incident_number=incident_number,
+            dispatch_incident_number=dispatch_incident_number,
+            status=status,
+            last_modified=last_modified,
+            sort_by=sort_by,
+            sort_direction=sort_direction,
+            page_size=page_size,
+            cursor=cursor,
+        )
+
+        # delete null params
+        for k in list(params.keys()):
+            if params[k] is None:
+                del params[k]
+
+        return self._call("get", "/incident", params=params)
+
     def patch_entity(self, neris_id: str, body: str | Dict[str, Any]) -> Dict[str, Any]:
         return self._call("patch", f"/entity/{neris_id}", data=body, model=PatchDepartmentPayload)
 
+    def create_station(self, neris_id_entity: str, body: str | Dict[str, Any]) -> Dict[str, Any]:
+        return self._call(
+            "post", f"/entity/{neris_id_entity}/station", data=body, model=CreateStationPayload
+        )
+
     def patch_station(
         self, neris_id_entity: str, neris_id_station: str, body: str | Dict[str, Any]
     ) -> Dict[str, Any]:
@@ -280,6 +341,16 @@ class NerisApiClient(_NerisApiClient):
             model=PatchStationPayload,
         )
 
+    def create_unit(
+        self, neris_id_entity: str, neris_id_station: str, body: str | Dict[str, Any]
+    ) -> Dict[str, Any]:
+        return self._call(
+            "post",
+            f"/entity/{neris_id_entity}/station/{neris_id_station}",
+            data=body,
+            model=CreateUnitPayload,
+        )
+
     def patch_unit(
         self,
         neris_id_entity: str,
@@ -314,10 +385,10 @@ class NerisApiClient(_NerisApiClient):
         )
 
     def create_api_integration(self, neris_id: str, title: str) -> Dict[str, Any]:
-        return self._call("post", f"/account/integration/{neris_id}", data={ "title": title })
+        return self._call("post", f"/account/integration/{neris_id}", data={"title": title})
 
     def generate_api_secret(self, client_id: str, title: str) -> Dict[str, Any]:
-        return self._call("post", f"/account/credential/{client_id}", data={ "title": title })
+        return self._call("post", f"/account/credential/{client_id}", data={"title": title})
 
     def list_integrations(self, neris_id: str) -> Dict[str, Any]:
         return self._call("get", f"/account/integration/{neris_id}/list")