neris-api-client 1.3.6__tar.gz → 1.5.0__tar.gz

{neris_api_client-1.3.6/src/neris_api_client.egg-info → neris_api_client-1.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: neris_api_client
-Version: 1.3.6
+Version: 1.5.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.6 → neris_api_client-1.5.0}/pyproject.toml

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

{neris_api_client-1.3.6 → neris_api_client-1.5.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
@@ -11,6 +11,10 @@ from pydantic import BaseModel
 from .config import Config, GrantType, TokenSet
 
 from .models import (
+    DeptSortBy,
+    StatesTerrs,
+    SortDirection,
+    TypeEntityValue,
     IncidentPayload,
     PatchUnitPayload,
     CreateUnitPayload,
@@ -228,6 +232,37 @@ class NerisApiClient(_NerisApiClient):
     def get_entity(self, neris_id: str) -> Dict[str, Any]:
         return self._call("get", f"/entity/{neris_id}")
 
+    def list_entities(
+        self,
+        name: str | None = None,
+        neris_id: str | None = None,
+        state: StatesTerrs | None = None,
+        entity_subtype: TypeEntityValue | None = None,
+        last_modified: str | None = None,
+        page_number: int | None = None,
+        page_size: int | None = None,
+        sort_by: DeptSortBy | None = None,
+        sort_direction: SortDirection | None = None,
+    ) -> Dict[str, Any]:
+        params = dict(
+            name=name,
+            neris_id=neris_id,
+            state=state,
+            entity_subtype=entity_subtype,
+            last_modified=last_modified,
+            page_number=page_number,
+            page_size=page_size,
+            sort_by=sort_by,
+            sort_direction=sort_direction,
+        )
+
+        # delete null params
+        for k in list(params.keys()):
+            if params[k] is None:
+                del params[k]
+
+        return self._call("get", "/entity", params=params)
+
     def create_entity(self, body: str | Dict[str, Any]) -> Dict[str, Any]:
         return self._call("post", "/entity/", body, model=CreateDepartmentPayload)
 
@@ -283,6 +318,46 @@ 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)