neris-api-client 0.0.1__tar.gz

neris_api_client-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Underwriters Laboratories, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

neris_api_client-0.0.1/PKG-INFO

@@ -0,0 +1,35 @@
+Metadata-Version: 2.1
+Name: neris_api_client
+Version: 0.0.1
+Summary: NERIS API Client
+Author-email: Ben Coleman <ben.coleman@ul.org>
+Project-URL: Homepage, https://github.com/ulfsri/neris
+Project-URL: Issues, https://github.com/ulfsri/neris/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: boto3
+Requires-Dist: PyJWT
+Requires-Dist: requests
+Requires-Dist: pydantic>=2
+Requires-Dist: typing_extensions
+
+# NERIS API Client
+
+A Python class to interact with the NERIS API programmatically.
+
+## Usage
+The client requires a username and password for authentication and authorization of requests unless the `env` argument is set to `local`
+at instantiation. The `local` environment is intended for development use on local machines and bypasses auth.
+
+```python
+from neris_api_client import NerisApiClient
+
+client = NerisApiClient(username="neris.user", password="*******", env="dev")
+
+# Get an organization
+org = client.get_org("FD24027240")
+```

neris_api_client-0.0.1/README.md

@@ -0,0 +1,16 @@
+# NERIS API Client
+
+A Python class to interact with the NERIS API programmatically.
+
+## Usage
+The client requires a username and password for authentication and authorization of requests unless the `env` argument is set to `local`
+at instantiation. The `local` environment is intended for development use on local machines and bypasses auth.
+
+```python
+from neris_api_client import NerisApiClient
+
+client = NerisApiClient(username="neris.user", password="*******", env="dev")
+
+# Get an organization
+org = client.get_org("FD24027240")
+```

neris_api_client-0.0.1/pyproject.toml

@@ -0,0 +1,29 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "neris_api_client"
+version = "0.0.1"
+authors = [
+  { name="Ben Coleman", email="ben.coleman@ul.org" },
+]
+description = "NERIS API Client"
+readme = "README.md"
+requires-python = ">=3.8"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+dependencies = [
+    "boto3",
+    "PyJWT",
+    "requests",
+    "pydantic>=2",
+    "typing_extensions",
+]
+
+[project.urls]
+Homepage = "https://github.com/ulfsri/neris"
+Issues = "https://github.com/ulfsri/neris/issues"

neris_api_client-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

neris_api_client-0.0.1/src/neris_api_client/__init__.py

@@ -0,0 +1 @@
+from .client import *

neris_api_client-0.0.1/src/neris_api_client/client.py

@@ -0,0 +1,215 @@
+import jwt
+import json
+from enum import Enum
+from uuid import UUID
+from typing import Optional, Dict, Any, Callable
+from pathlib import Path
+from datetime import datetime, timedelta
+
+import boto3
+import requests
+from pydantic import BaseModel
+
+from .models import (
+    CreateDepartmentPayload,
+    DepartmentPayload,
+    CreateUserPayload,
+    UpdateUserPayload,
+)
+
+__all__ = ("NerisApiClient",)
+
+
+class Environment(str, Enum):
+    DEV = "dev"
+    PROD = "prod"
+    LOCAL = "local"
+
+
+BASE_URLS = {
+    Environment.LOCAL: "http://localhost:8000",
+    Environment.DEV: "https://api-dev.neris.fsri.org/v1",
+    Environment.PROD: "https://api.neris.fsri.org/v1",
+}
+
+COGNTIO_CLIENT_CONFIG_URL = (
+    "https://neris-{env}-public.s3.us-east-2.amazonaws.com/cognito_config.json"
+)
+
+
+class _NerisApiClient:
+    def __init__(
+        self,
+        env: Environment = Environment.LOCAL,
+        username: str = "",
+        password: str = "",
+    ):
+        self._username = username
+        self._password = password
+        self._base_url = BASE_URLS[env]
+        self._env = env
+
+        self._access_token: str = None
+        self._access_token_exp: datetime = None
+        self._refresh_token: str = None
+        self._id_token: str = None
+        self._id_token_exp: datetime = None
+        self._cognito_config = None
+        self._session: requests.Session = requests.Session()
+
+        # Don't mess with auth on localhost
+        if env == Environment.LOCAL:
+            # Non-existent auth token never expires
+            self._access_token_exp = datetime.now() + timedelta(weeks=52)
+            return
+
+        self._cognito = boto3.client("cognito-idp")
+
+        self._token_cache_path = Path("./.token_cache")
+        self._access_token_cache_path = self._token_cache_path / "access_token"
+        self._refresh_token_cache_path = self._token_cache_path / "refresh_token"
+        self._id_token_cache_path = self._token_cache_path / "id_token"
+        self._cognito_config_cache_path = self._token_cache_path / "cognito_config.json"
+
+        self._read_token_cache()
+
+        if self._access_token:
+            self._set_token_exp()
+
+        if not self._access_token:
+            self._initiate_auth()
+
+    def _fetch_cognito_config(f: Callable) -> Callable:
+        def fetch_cognito_config(self):
+            if self._cognito_config is None:
+                self._cognito_config = requests.get(
+                    COGNTIO_CLIENT_CONFIG_URL.format(env=self._env)
+                ).json()
+            return f(self)
+
+        return fetch_cognito_config
+
+    @_fetch_cognito_config
+    def _initiate_auth(self) -> None:
+        res = self._cognito.initiate_auth(
+            AuthFlow="USER_PASSWORD_AUTH",
+            AuthParameters={"USERNAME": self._username, "PASSWORD": self._password},
+            ClientId=self._cognito_config["client_id"],
+        )
+
+        self._access_token = res["AuthenticationResult"]["AccessToken"]
+        self._refresh_token = res["AuthenticationResult"]["RefreshToken"]
+        self._id_token = res["AuthenticationResult"]["IdToken"]
+
+        self._set_token_exp()
+
+        self._write_token_cache()
+
+    @_fetch_cognito_config
+    def _refresh_auth(self) -> None:
+        res = self._cognito.initiate_auth(
+            AuthFlow="REFRESH_TOKEN_AUTH",
+            AuthParameters={"REFRESH_TOKEN": self._refresh_token},
+            ClientId=self._cogntio_config["client_id"],
+        )
+
+        self._access_token = res["AuthenticationResult"]["AccessToken"]
+        self._id_token = res["AuthenticationResult"]["IdToken"]
+
+        self._set_token_exp()
+
+        self._write_token_cache()
+
+    def _set_token_exp(self):
+        self._access_token_exp = datetime.fromtimestamp(
+            self._decode_token(self._access_token)["exp"]
+        )
+        self._id_token_exp = datetime.fromtimestamp(
+            self._decode_token(self._id_token)["exp"]
+        )
+
+    def _read_token_cache(self):
+        if self._access_token_cache_path.exists():
+            self._access_token = self._access_token_cache_path.read_text()
+        if self._refresh_token_cache_path.exists():
+            self._refresh_token = self._refresh_token_cache_path.read_text()
+        if self._id_token_cache_path.exists():
+            self._id_token = self._id_token_cache_path.read_text()
+        if self._cognito_config_cache_path.exists():
+            self._cognito_config = json.loads(
+                self._cognito_config_cache_path.read_text()
+            )
+
+    def _write_token_cache(self):
+        self._token_cache_path.mkdir(exist_ok=True)
+        self._access_token_cache_path.write_text(self._access_token)
+        self._refresh_token_cache_path.write_text(self._refresh_token)
+        self._id_token_cache_path.write_text(self._id_token)
+        self._cognito_config_cache_path.write_text(json.dumps(self._cognito_config))
+
+    @staticmethod
+    def _decode_token(token: str, verify: bool = False):
+        return jwt.decode(token, options={"verify_signature": verify})
+
+    def _call(
+        self,
+        method: str,
+        path: str,
+        data: Optional[str | Dict[str, Any]] = None,
+        model: Optional[BaseModel] = None,
+    ):
+        if self._access_token_exp - datetime.now() <= timedelta(seconds=0):
+            try:
+                self._refresh_auth()
+            except:
+                self._initiate_auth()
+
+        if self._env != Environment.LOCAL:
+            self._session.headers.update(
+                {"Authorization": f"Bearer {self._access_token}"}
+            )
+
+        if model:
+            if isinstance(data, str):
+                data = model.model_validate_json(data).model_dump(mode="json")
+            if isinstance(data, dict):
+                data = model.model_validate(data).model_dump(mode="json")
+
+        res = getattr(self._session, method)(f"{self._base_url}{path}", json=data)
+
+        try:
+            res.raise_for_status()
+        except requests.exceptions.HTTPError as e:
+            try:
+                e.args = e.args + (e.response.json(),)
+                raise e
+            except requests.exceptions.JSONDecodeError as f:
+                e.args = e.args + (e.response.text,)
+                raise e
+
+        return res.json()
+
+
+class NerisApiClient(_NerisApiClient):
+    def health(self):
+        return self._call("get", "/health")
+
+    def get_org(self, neris_id: str) -> Dict[str, Any]:
+        return self._call("get", f"/org/{neris_id}")
+
+    def create_org(self, body: str | Dict[str, Any]) -> Dict[str, Any]:
+        return self._call("post", "/org/", body, model=CreateDepartmentPayload)
+
+    def update_org(self, neris_id: str, body: str | Dict[str, Any]) -> Dict[str, Any]:
+        return self._call("put", f"/org/{neris_id}", body, model=DepartmentPayload)
+
+    def get_user(self, sub: str | UUID) -> Dict[str, Any]:
+        return self._call("get", f"/user/{sub}")
+
+    def create_user(self, body: str | Dict[str, Any]) -> Dict[str, Any]:
+        return self._call("post", "/user", body, model=CreateUserPayload)
+
+    def update_user(
+        self, sub: str | UUID, body: str | Dict[str, Any]
+    ) -> Dict[str, Any]:
+        return self._call("put", f"/user/{sub}", body, model=UpdateUserPayload)

neris_api_client-0.0.1/src/neris_api_client/models.py

@@ -0,0 +1,673 @@
+# generated by datamodel-codegen:
+#   filename:  openapi.json
+#   timestamp: 2024-03-22T18:44:46+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+from typing import List, Optional, Union
+from uuid import UUID
+
+from pydantic import AwareDatetime, BaseModel, EmailStr, Field, constr
+from typing_extensions import Literal
+
+
+class AssessmentPayload(BaseModel):
+    iso_rating: Optional[int] = Field(None, title='Iso Rating')
+    cpse_acredited: Optional[bool] = Field(None, title='Cpse Acredited')
+    caas_acredited: Optional[bool] = Field(None, title='Caas Acredited')
+
+
+class AssessmentResponse(BaseModel):
+    iso_rating: Optional[int] = Field(None, title='Iso Rating')
+    cpse_acredited: Optional[bool] = Field(None, title='Cpse Acredited')
+    caas_acredited: Optional[bool] = Field(None, title='Caas Acredited')
+
+
+class ContactPayload(BaseModel):
+    name: Optional[str] = Field(None, title='Name')
+    title: Optional[str] = Field(None, title='Title')
+    phone: Optional[str] = Field(None, title='Phone')
+    email: Optional[str] = Field(None, title='Email')
+
+
+class ContactResponse(BaseModel):
+    name: Optional[str] = Field(None, title='Name')
+    title: Optional[str] = Field(None, title='Title')
+    phone: Optional[str] = Field(None, title='Phone')
+    email: Optional[str] = Field(None, title='Email')
+
+
+class CreateUserPayload(BaseModel):
+    username: str = Field(..., title='Username')
+    email: EmailStr = Field(..., title='Email')
+    phone_number: Optional[
+        constr(
+            pattern=r'^(\+?[1|0])?( )*([ \[\(])?\d{3}([\)\]\. \-])?( )*\d{3}([\. \-])?( )*\d{4}$'
+        )
+    ] = Field(None, title='Phone Number')
+
+
+class GeoJsonMultiPolygon(BaseModel):
+    type: Literal['MultiPolygon'] = Field(..., title='Type')
+    coordinates: List[List[List[List[float]]]] = Field(..., title='Coordinates')
+
+
+class GeoJsonPoint(BaseModel):
+    type: Literal['Point'] = Field(..., title='Type')
+    coordinates: List[float] = Field(..., title='Coordinates')
+
+
+class ShiftPayload(BaseModel):
+    count: Optional[int] = Field(None, title='Count')
+    duration: Optional[int] = Field(None, title='Duration')
+    signup: Optional[int] = Field(None, title='Signup')
+
+
+class ShiftResponse(BaseModel):
+    count: Optional[int] = Field(None, title='Count')
+    duration: Optional[int] = Field(None, title='Duration')
+    signup: Optional[int] = Field(None, title='Signup')
+
+
+class StaffingPayload(BaseModel):
+    active_firefighters_career_ft: Optional[int] = Field(
+        None, title='Active Firefighters Career Ft'
+    )
+    active_firefighters_career_pt: Optional[int] = Field(
+        None, title='Active Firefighters Career Pt'
+    )
+    active_firefighters_volunteer: Optional[int] = Field(
+        None, title='Active Firefighters Volunteer'
+    )
+    active_ems_only_career_ft: Optional[int] = Field(None, title='Active Ems Only Career Ft')
+    active_ems_only_career_pt: Optional[int] = Field(None, title='Active Ems Only Career Pt')
+    active_ems_only_volunteer: Optional[int] = Field(None, title='Active Ems Only Volunteer')
+    active_civilians_career_ft: Optional[int] = Field(None, title='Active Civilians Career Ft')
+    active_civilians_career_pt: Optional[int] = Field(None, title='Active Civilians Career Pt')
+    active_civilians_volunteer: Optional[int] = Field(None, title='Active Civilians Volunteer')
+
+
+class StaffingResponse(BaseModel):
+    active_firefighters_career_ft: Optional[int] = Field(
+        None, title='Active Firefighters Career Ft'
+    )
+    active_firefighters_career_pt: Optional[int] = Field(
+        None, title='Active Firefighters Career Pt'
+    )
+    active_firefighters_volunteer: Optional[int] = Field(
+        None, title='Active Firefighters Volunteer'
+    )
+    active_ems_only_career_ft: Optional[int] = Field(None, title='Active Ems Only Career Ft')
+    active_ems_only_career_pt: Optional[int] = Field(None, title='Active Ems Only Career Pt')
+    active_ems_only_volunteer: Optional[int] = Field(None, title='Active Ems Only Volunteer')
+    active_civilians_career_ft: Optional[int] = Field(None, title='Active Civilians Career Ft')
+    active_civilians_career_pt: Optional[int] = Field(None, title='Active Civilians Career Pt')
+    active_civilians_volunteer: Optional[int] = Field(None, title='Active Civilians Volunteer')
+
+
+class StatesTerrs(Enum):
+    AL = 'AL'
+    AK = 'AK'
+    AS = 'AS'
+    AZ = 'AZ'
+    AR = 'AR'
+    CA = 'CA'
+    CO = 'CO'
+    CT = 'CT'
+    DE = 'DE'
+    DC = 'DC'
+    FL = 'FL'
+    GA = 'GA'
+    GU = 'GU'
+    HI = 'HI'
+    ID = 'ID'
+    IL = 'IL'
+    IN = 'IN'
+    IA = 'IA'
+    KS = 'KS'
+    KY = 'KY'
+    LA = 'LA'
+    ME = 'ME'
+    MD = 'MD'
+    MA = 'MA'
+    MI = 'MI'
+    MN = 'MN'
+    MS = 'MS'
+    MO = 'MO'
+    MP = 'MP'
+    MT = 'MT'
+    NA = 'NA'
+    NE = 'NE'
+    NV = 'NV'
+    NH = 'NH'
+    NJ = 'NJ'
+    NM = 'NM'
+    NY = 'NY'
+    NC = 'NC'
+    ND = 'ND'
+    OH = 'OH'
+    OK = 'OK'
+    OR = 'OR'
+    PA = 'PA'
+    PR = 'PR'
+    RI = 'RI'
+    SC = 'SC'
+    SD = 'SD'
+    TN = 'TN'
+    TX = 'TX'
+    UT = 'UT'
+    VT = 'VT'
+    VA = 'VA'
+    VI = 'VI'
+    WA = 'WA'
+    WV = 'WV'
+    WI = 'WI'
+    WY = 'WY'
+
+
+class TypeDeptValue(Enum):
+    CAREER = 'CAREER'
+    VOLUNTEER = 'VOLUNTEER'
+    COMBINED = 'COMBINED'
+
+
+class TypeDispProtoFireValue(Enum):
+    PROQA = 'PROQA'
+    IAED = 'IAED'
+    APCO = 'APCO'
+
+
+class TypeDispProtoMedValue(Enum):
+    PROQA = 'PROQA'
+    IAED = 'IAED'
+    APCO = 'APCO'
+
+
+class TypeEmsServValue(Enum):
+    NO_MEDICAL = 'NO_MEDICAL'
+    BLS_NO_TRANSPORT = 'BLS_NO_TRANSPORT'
+    ALS_NO_TRANSPORT = 'ALS_NO_TRANSPORT'
+    BLS_TRANSPORT = 'BLS_TRANSPORT'
+    ALS_TRANSPORT = 'ALS_TRANSPORT'
+    AERO_TRANSPORT = 'AERO_TRANSPORT'
+    COMMUNITY_MED = 'COMMUNITY_MED'
+
+
+class TypeFdServValue(Enum):
+    STRUCTURAL_FIREFIGHTING = 'STRUCTURAL_FIREFIGHTING'
+    HIGHRISE_FIREFIGHTING = 'HIGHRISE_FIREFIGHTING'
+    WILDLAND_FIREFIGHTING = 'WILDLAND_FIREFIGHTING'
+    PETROCHEM_FIREFIGHTING = 'PETROCHEM_FIREFIGHTING'
+    ARFF_FIREFIGHTING = 'ARFF_FIREFIGHTING'
+    MARINE_FIREFIGHTING = 'MARINE_FIREFIGHTING'
+    HAZMAT_OPS = 'HAZMAT_OPS'
+    HAZMAT_TECHNICIAN = 'HAZMAT_TECHNICIAN'
+    ROPE_RESCUE = 'ROPE_RESCUE'
+    COLLAPSE_RESCUE = 'COLLAPSE_RESCUE'
+    VEHICLE_RESCUE = 'VEHICLE_RESCUE'
+    ANIMAL_TECHRESCUE = 'ANIMAL_TECHRESCUE'
+    WILDERNESS_SAR = 'WILDERNESS_SAR'
+    TRENCH_RESCUE = 'TRENCH_RESCUE'
+    CONFINED_SPACE = 'CONFINED_SPACE'
+    MACHINERY_RESCUE = 'MACHINERY_RESCUE'
+    CAVE_SAR = 'CAVE_SAR'
+    MINE_SAR = 'MINE_SAR'
+    HELO_SAR = 'HELO_SAR'
+    WATER_SAR = 'WATER_SAR'
+    SWIFTWATER_SAR = 'SWIFTWATER_SAR'
+    DIVE_SAR = 'DIVE_SAR'
+    ICE_RESCUE = 'ICE_RESCUE'
+    SURF_RESCUE = 'SURF_RESCUE'
+    WATERCRAFT_RESCUE = 'WATERCRAFT_RESCUE'
+    FLOOD_SAR = 'FLOOD_SAR'
+    TOWER_SAR = 'TOWER_SAR'
+    REHABILITATION = 'REHABILITATION'
+    RRD_EXISTING = 'RRD_EXISTING'
+    RRD_NEWCONST = 'RRD_NEWCONST'
+    RRD_PUBLICED = 'RRD_PUBLICED'
+    RRD_PLANS = 'RRD_PLANS'
+    CAUSE_ORIGIN = 'CAUSE_ORIGIN'
+    TRAINING_ELF = 'TRAINING_ELF'
+    TRAINING_VETFF = 'TRAINING_VETFF'
+    TRAINING_OD = 'TRAINING_OD'
+    TRAINING_DRIVER = 'TRAINING_DRIVER'
+
+
+class TypeGeoSourceValue(Enum):
+    DEPT_UPLOAD = 'DEPT_UPLOAD'
+    DEPT_FILE = 'DEPT_FILE'
+    AWS = 'AWS'
+
+
+class TypeInvestServValue(Enum):
+    COMPANY_LEVEL = 'COMPANY_LEVEL'
+    JUVENILE_FIRESETTER = 'JUVENILE_FIRESETTER'
+    DEDICATED = 'DEDICATED'
+    LAW_ENFORCEMENT = 'LAW_ENFORCEMENT'
+    K9_DETECT = 'K9_DETECT'
+
+
+class TypeOrgValue(Enum):
+    LOCAL = 'LOCAL'
+    TRIBAL_GOVT = 'TRIBAL_GOVT'
+    PRIVATE = 'PRIVATE'
+    DOD = 'DOD'
+    SFM = 'SFM'
+    FEDERAL = 'FEDERAL'
+
+
+class TypePopSourceValue(Enum):
+    DEPARTMENT_ENTERED = 'DEPARTMENT_ENTERED'
+    CENSUS_DERIVED = 'CENSUS_DERIVED'
+
+
+class TypePsapCapaValue(Enum):
+    LEGACY = 'LEGACY'
+    NG911 = 'NG911'
+
+
+class TypePsapDiscValue(Enum):
+    SINGLE = 'SINGLE'
+    MULTIPLE = 'MULTIPLE'
+
+
+class TypePsapJurisValue(Enum):
+    SINGLE = 'SINGLE'
+    MULTIPLE = 'MULTIPLE'
+
+
+class TypePsapValue(Enum):
+    PRIMARY = 'PRIMARY'
+    SECONDARY = 'SECONDARY'
+
+
+class TypeRegionValue(Enum):
+    BATTALION = 'BATTALION'
+    COUNCIL_DISTRICT = 'COUNCIL_DISTRICT'
+    DISTRICT = 'DISTRICT'
+    DIVISION = 'DIVISION'
+    FIRST_DUE = 'FIRST_DUE'
+    OTHER = 'OTHER'
+
+
+class TypeUnitValue(Enum):
+    CREW_TRANS = 'CREW_TRANS'
+    ENGINE_STRUCT = 'ENGINE_STRUCT'
+    ENGINE_WUI = 'ENGINE_WUI'
+    BOAT = 'BOAT'
+    BOAT_LARGE = 'BOAT_LARGE'
+    LADDER_SMALL = 'LADDER_SMALL'
+    LADDER_QUINT = 'LADDER_QUINT'
+    LADDER_TALL = 'LADDER_TALL'
+    QUINT_TALL = 'QUINT_TALL'
+    PLATFORM = 'PLATFORM'
+    PLATFORM_QUINT = 'PLATFORM_QUINT'
+    LADDER_TILLER = 'LADDER_TILLER'
+    ARFF = 'ARFF'
+    FOAM = 'FOAM'
+    TENDER = 'TENDER'
+    CREW = 'CREW'
+    HELO_GENERAL = 'HELO_GENERAL'
+    HELO_FIRE = 'HELO_FIRE'
+    HELO_RESCUE = 'HELO_RESCUE'
+    UAS_FIRE = 'UAS_FIRE'
+    UAS_RECON = 'UAS_RECON'
+    AIR_TANKER = 'AIR_TANKER'
+    AIR_EMS = 'AIR_EMS'
+    AIR_RECON = 'AIR_RECON'
+    ALS_AMB = 'ALS_AMB'
+    BLS_AMB = 'BLS_AMB'
+    EMS_NOTRANS = 'EMS_NOTRANS'
+    EMS_SUPV = 'EMS_SUPV'
+    CHIEF = 'CHIEF'
+    HAZMAT = 'HAZMAT'
+    DECON = 'DECON'
+    POV = 'POV'
+    RESCUE_HEAVY = 'RESCUE_HEAVY'
+    RESCUE_MEDIUM = 'RESCUE_MEDIUM'
+    RESCUE_LIGHT = 'RESCUE_LIGHT'
+    RESCUE_USAR = 'RESCUE_USAR'
+    RESCUE_WATER = 'RESCUE_WATER'
+    SCBA = 'SCBA'
+    AIR_LIGHT = 'AIR_LIGHT'
+    REHAB = 'REHAB'
+    MOBILE_ICP = 'MOBILE_ICP'
+    MOBILE_COMMS = 'MOBILE_COMMS'
+    DOZER = 'DOZER'
+    OTHER_GROUND = 'OTHER_GROUND'
+    ATV_EMS = 'ATV_EMS'
+    ATV_FIRE = 'ATV_FIRE'
+    INVEST = 'INVEST'
+    UTIL = 'UTIL'
+
+
+class UnitCreatedModifiedResponse(BaseModel):
+    neris_id: str = Field(..., title='Neris Id')
+    version: int = Field(..., title='Version')
+    valid_start: AwareDatetime = Field(..., title='Valid Start')
+
+
+class UnitPayload(BaseModel):
+    type: TypeUnitValue
+    staffing: int = Field(..., title='Staffing')
+    cad_designation_1: Optional[str] = Field(None, title='Cad Designation 1')
+    cad_designation_2: Optional[str] = Field(None, title='Cad Designation 2')
+    neris_id: str = Field(..., title='Neris Id')
+
+
+class UnitResponse(BaseModel):
+    neris_id: str = Field(..., title='Neris Id')
+    version: int = Field(..., title='Version')
+    type: TypeUnitValue
+    staffing: int = Field(..., title='Staffing')
+    cad_designation_1: Optional[str] = Field(None, title='Cad Designation 1')
+    cad_designation_2: Optional[str] = Field(None, title='Cad Designation 2')
+
+
+class UpdateUserPayload(BaseModel):
+    email: EmailStr = Field(..., title='Email')
+    phone_number: Optional[
+        constr(
+            pattern=r'^(\+?[1|0])?( )*([ \[\(])?\d{3}([\)\]\. \-])?( )*\d{3}([\. \-])?( )*\d{4}$'
+        )
+    ] = Field(None, title='Phone Number')
+
+
+class UserActivationPayload(BaseModel):
+    active: bool = Field(..., title='Active')
+
+
+class UserStatus(Enum):
+    UNCONFIRMED = 'UNCONFIRMED'
+    CONFIRMED = 'CONFIRMED'
+    UNKNOWN = 'UNKNOWN'
+    RESET_REQUIRED = 'RESET_REQUIRED'
+    FORCE_CHANGE_PASSWORD = 'FORCE_CHANGE_PASSWORD'
+
+
+class ValidationError(BaseModel):
+    loc: List[Union[str, int]] = Field(..., title='Location')
+    msg: str = Field(..., title='Message')
+    type: str = Field(..., title='Error Type')
+
+
+class CreateUnitPayload(BaseModel):
+    type: TypeUnitValue
+    staffing: int = Field(..., title='Staffing')
+    cad_designation_1: Optional[str] = Field(None, title='Cad Designation 1')
+    cad_designation_2: Optional[str] = Field(None, title='Cad Designation 2')
+
+
+class DispatchPayload(BaseModel):
+    avl_usage: Optional[bool] = Field(None, title='Avl Usage')
+    center_id: Optional[int] = Field(None, title='Center Id')
+    cad_software: Optional[str] = Field(None, title='Cad Software')
+    psap_type: Optional[TypePsapValue] = None
+    psap_capability: Optional[TypePsapCapaValue] = None
+    psap_discipline: Optional[TypePsapDiscValue] = None
+    psap_jurisdiction: Optional[TypePsapJurisValue] = None
+    protocol_fire: Optional[TypeDispProtoFireValue] = None
+    protocol_med: Optional[TypeDispProtoMedValue] = None
+
+
+class DispatchResponse(BaseModel):
+    avl_usage: Optional[bool] = Field(None, title='Avl Usage')
+    center_id: Optional[int] = Field(None, title='Center Id')
+    cad_software: Optional[str] = Field(None, title='Cad Software')
+    psap_type: Optional[TypePsapValue] = None
+    psap_capability: Optional[TypePsapCapaValue] = None
+    protocol_fire: Optional[TypeDispProtoFireValue] = None
+    protocol_med: Optional[TypeDispProtoMedValue] = None
+
+
+class GeoPoint(BaseModel):
+    crs: Optional[Union[int, str]] = Field(4326, title='Crs')
+    source: TypeGeoSourceValue
+    geometry: GeoJsonPoint
+
+
+class GeoPointResponse(BaseModel):
+    crs: Optional[int] = Field(4326, title='Crs')
+    source: TypeGeoSourceValue
+    geometry: GeoJsonPoint
+
+
+class HTTPValidationError(BaseModel):
+    detail: Optional[List[ValidationError]] = Field(None, title='Detail')
+
+
+class OrgSummaryInfoResponse(BaseModel):
+    name: str = Field(..., title='Name')
+    neris_id: str = Field(..., title='Neris Id')
+    city: str = Field(..., title='City')
+    state: StatesTerrs
+    zip_code: str = Field(..., title='Zip Code')
+
+
+class OrgsSummaryInfoResponse(BaseModel):
+    count: int = Field(..., title='Count')
+    orgs: List[OrgSummaryInfoResponse] = Field(..., title='Orgs')
+
+
+class PopulationPayload(BaseModel):
+    source: Optional[TypePopSourceValue] = None
+    protected: Optional[int] = Field(None, title='Protected')
+
+
+class PopulationResponse(BaseModel):
+    source: Optional[TypePopSourceValue] = None
+    protected: Optional[int] = Field(None, title='Protected')
+
+
+class RegionPayload(BaseModel):
+    crs: Optional[Union[int, str]] = Field(4326, title='Crs')
+    source: TypeGeoSourceValue
+    geometry: GeoJsonMultiPolygon
+    name: Optional[str] = Field(None, title='Name')
+    internal_id: Optional[str] = Field(None, title='Internal Id')
+
+
+class RegionResponse(BaseModel):
+    crs: Optional[int] = Field(4326, title='Crs')
+    source: TypeGeoSourceValue
+    geometry: GeoJsonMultiPolygon
+    name: Optional[str] = Field(None, title='Name')
+    internal_id: Optional[str] = Field(None, title='Internal Id')
+
+
+class RegionSetPayload(BaseModel):
+    name: Optional[str] = Field(None, title='Name')
+    type: TypeRegionValue
+    primary: bool = Field(..., title='Primary')
+    coverage: bool = Field(..., title='Coverage')
+    juris: bool = Field(..., title='Juris')
+    regions: Optional[List[RegionPayload]] = Field(None, title='Regions')
+
+
+class RegionSetResponse(BaseModel):
+    name: Optional[str] = Field(None, title='Name')
+    type: TypeRegionValue
+    primary: bool = Field(..., title='Primary')
+    coverage: bool = Field(..., title='Coverage')
+    juris: bool = Field(..., title='Juris')
+    regions: Optional[List[RegionResponse]] = Field(None, title='Regions')
+
+
+class StationCreatedModifiedResponse(BaseModel):
+    neris_id: str = Field(..., title='Neris Id')
+    version: int = Field(..., title='Version')
+    valid_start: AwareDatetime = Field(..., title='Valid Start')
+    units: Optional[List[UnitCreatedModifiedResponse]] = Field(None, title='Units')
+
+
+class StationPayload(BaseModel):
+    address_line_1: str = Field(..., title='Address Line 1')
+    address_line_2: Optional[str] = Field(None, title='Address Line 2')
+    city: str = Field(..., title='City')
+    state: StatesTerrs
+    zip_code: str = Field(..., title='Zip Code')
+    station_id: str = Field(..., title='Station Id')
+    internal_id: Optional[str] = Field(None, title='Internal Id')
+    staffing: Optional[int] = Field(None, title='Staffing')
+    units: Optional[List[Union[UnitPayload, CreateUnitPayload]]] = Field(None, title='Units')
+    location: Optional[GeoPoint] = None
+    neris_id: str = Field(..., title='Neris Id')
+
+
+class StationResponse(BaseModel):
+    address_line_1: str = Field(..., title='Address Line 1')
+    address_line_2: Optional[str] = Field(None, title='Address Line 2')
+    city: str = Field(..., title='City')
+    state: StatesTerrs
+    zip_code: str = Field(..., title='Zip Code')
+    neris_id: str = Field(..., title='Neris Id')
+    version: int = Field(..., title='Version')
+    station_id: str = Field(..., title='Station Id')
+    staffing: Optional[int] = Field(None, title='Staffing')
+    location: Optional[GeoPointResponse] = None
+    units: Optional[List[UnitResponse]] = Field(None, title='Units')
+
+
+class UserResponse(BaseModel):
+    username: str = Field(..., title='Username')
+    sub: UUID = Field(..., title='Sub')
+    email: Optional[EmailStr] = Field(None, title='Email')
+    phone_number: Optional[
+        constr(
+            pattern=r'^(\+?[1|0])?( )*([ \[\(])?\d{3}([\)\]\. \-])?( )*\d{3}([\. \-])?( )*\d{4}$'
+        )
+    ] = Field(None, title='Phone Number')
+    status: UserStatus
+    active: bool = Field(..., title='Active')
+
+
+class CreateStationPayload(BaseModel):
+    address_line_1: str = Field(..., title='Address Line 1')
+    address_line_2: Optional[str] = Field(None, title='Address Line 2')
+    city: str = Field(..., title='City')
+    state: StatesTerrs
+    zip_code: str = Field(..., title='Zip Code')
+    station_id: str = Field(..., title='Station Id')
+    internal_id: Optional[str] = Field(None, title='Internal Id')
+    staffing: Optional[int] = Field(None, title='Staffing')
+    units: Optional[List[CreateUnitPayload]] = Field(None, title='Units')
+    location: Optional[GeoPoint] = None
+
+
+class DepartmentCreatedModifiedResponse(BaseModel):
+    neris_id: str = Field(..., title='Neris Id')
+    version: int = Field(..., title='Version')
+    valid_start: AwareDatetime = Field(..., title='Valid Start')
+    stations: Optional[List[StationCreatedModifiedResponse]] = Field(None, title='Stations')
+
+
+class DepartmentPayload(BaseModel):
+    address_line_1: str = Field(..., title='Address Line 1')
+    address_line_2: Optional[str] = Field(None, title='Address Line 2')
+    city: str = Field(..., title='City')
+    state: StatesTerrs
+    zip_code: str = Field(..., title='Zip Code')
+    internal_id: Optional[str] = Field(None, title='Internal Id')
+    name: str = Field(..., title='Name')
+    mail_address_line_1: Optional[str] = Field(None, title='Mail Address Line 1')
+    mail_address_line_2: Optional[str] = Field(None, title='Mail Address Line 2')
+    mail_city: Optional[str] = Field(None, title='Mail City')
+    mail_state: Optional[StatesTerrs] = None
+    mail_zip_code: Optional[str] = Field(None, title='Mail Zip Code')
+    email: Optional[str] = Field(None, title='Email')
+    website: Optional[str] = Field(None, title='Website')
+    continue_edu: Optional[bool] = Field(None, title='Continue Edu')
+    department_type: Optional[TypeDeptValue] = None
+    organization_type: Optional[TypeOrgValue] = None
+    rms_software: Optional[str] = Field(None, title='Rms Software')
+    population: Optional[PopulationPayload] = None
+    dispatch: Optional[DispatchPayload] = None
+    staffing: Optional[StaffingPayload] = None
+    assessment: Optional[AssessmentPayload] = None
+    contact: Optional[ContactPayload] = None
+    shift: Optional[ShiftPayload] = None
+    fire_services: Optional[List[TypeFdServValue]] = Field(None, title='Fire Services')
+    ems_services: Optional[List[TypeEmsServValue]] = Field(None, title='Ems Services')
+    investigation_services: Optional[List[TypeInvestServValue]] = Field(
+        None, title='Investigation Services'
+    )
+    stations: Optional[List[Union[StationPayload, CreateStationPayload]]] = Field(
+        None, title='Stations'
+    )
+    location: Optional[GeoPoint] = None
+    region_sets: Optional[List[RegionSetPayload]] = Field(None, title='Region Sets')
+    neris_id: str = Field(..., title='Neris Id')
+
+
+class DepartmentResponse(BaseModel):
+    address_line_1: str = Field(..., title='Address Line 1')
+    address_line_2: Optional[str] = Field(None, title='Address Line 2')
+    city: str = Field(..., title='City')
+    state: StatesTerrs
+    zip_code: str = Field(..., title='Zip Code')
+    last_modified: AwareDatetime = Field(..., title='Last Modified')
+    neris_id: str = Field(..., title='Neris Id')
+    version: int = Field(..., title='Version')
+    internal_id: Optional[str] = Field(None, title='Internal Id')
+    name: str = Field(..., title='Name')
+    mail_address_line_1: Optional[str] = Field(None, title='Mail Address Line 1')
+    mail_address_line_2: Optional[str] = Field(None, title='Mail Address Line 2')
+    mail_city: Optional[str] = Field(None, title='Mail City')
+    mail_state: Optional[StatesTerrs] = None
+    mail_zip_code: Optional[str] = Field(None, title='Mail Zip Code')
+    email: Optional[str] = Field(None, title='Email')
+    website: Optional[str] = Field(None, title='Website')
+    continue_edu: Optional[bool] = Field(None, title='Continue Edu')
+    department_type: Optional[TypeDeptValue] = None
+    organization_type: Optional[TypeOrgValue] = None
+    rms_software: Optional[str] = Field(None, title='Rms Software')
+    population: Optional[PopulationResponse] = None
+    dispatch: Optional[DispatchResponse] = None
+    staffing: Optional[StaffingResponse] = None
+    assessment: Optional[AssessmentResponse] = None
+    contact: Optional[ContactResponse] = None
+    shift: Optional[ShiftResponse] = None
+    fire_services: Optional[List[TypeFdServValue]] = Field(None, title='Fire Services')
+    ems_services: Optional[List[TypeEmsServValue]] = Field(None, title='Ems Services')
+    investigation_services: Optional[List[TypeInvestServValue]] = Field(
+        None, title='Investigation Services'
+    )
+    stations: Optional[List[StationResponse]] = Field(None, title='Stations')
+    location: Optional[GeoPointResponse] = None
+    region_sets: Optional[List[RegionSetResponse]] = Field(None, title='Region Sets')
+
+
+class CreateDepartmentPayload(BaseModel):
+    address_line_1: str = Field(..., title='Address Line 1')
+    address_line_2: Optional[str] = Field(None, title='Address Line 2')
+    city: str = Field(..., title='City')
+    state: StatesTerrs
+    zip_code: str = Field(..., title='Zip Code')
+    internal_id: Optional[str] = Field(None, title='Internal Id')
+    name: str = Field(..., title='Name')
+    mail_address_line_1: Optional[str] = Field(None, title='Mail Address Line 1')
+    mail_address_line_2: Optional[str] = Field(None, title='Mail Address Line 2')
+    mail_city: Optional[str] = Field(None, title='Mail City')
+    mail_state: Optional[StatesTerrs] = None
+    mail_zip_code: Optional[str] = Field(None, title='Mail Zip Code')
+    email: Optional[str] = Field(None, title='Email')
+    website: Optional[str] = Field(None, title='Website')
+    continue_edu: Optional[bool] = Field(None, title='Continue Edu')
+    department_type: Optional[TypeDeptValue] = None
+    organization_type: Optional[TypeOrgValue] = None
+    rms_software: Optional[str] = Field(None, title='Rms Software')
+    population: Optional[PopulationPayload] = None
+    dispatch: Optional[DispatchPayload] = None
+    staffing: Optional[StaffingPayload] = None
+    assessment: Optional[AssessmentPayload] = None
+    contact: Optional[ContactPayload] = None
+    shift: Optional[ShiftPayload] = None
+    fire_services: Optional[List[TypeFdServValue]] = Field(None, title='Fire Services')
+    ems_services: Optional[List[TypeEmsServValue]] = Field(None, title='Ems Services')
+    investigation_services: Optional[List[TypeInvestServValue]] = Field(
+        None, title='Investigation Services'
+    )
+    stations: Optional[List[CreateStationPayload]] = Field(None, title='Stations')
+    location: Optional[GeoPoint] = None
+    region_sets: Optional[List[RegionSetPayload]] = Field(None, title='Region Sets')

neris_api_client-0.0.1/src/neris_api_client.egg-info/PKG-INFO

@@ -0,0 +1,35 @@
+Metadata-Version: 2.1
+Name: neris_api_client
+Version: 0.0.1
+Summary: NERIS API Client
+Author-email: Ben Coleman <ben.coleman@ul.org>
+Project-URL: Homepage, https://github.com/ulfsri/neris
+Project-URL: Issues, https://github.com/ulfsri/neris/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: boto3
+Requires-Dist: PyJWT
+Requires-Dist: requests
+Requires-Dist: pydantic>=2
+Requires-Dist: typing_extensions
+
+# NERIS API Client
+
+A Python class to interact with the NERIS API programmatically.
+
+## Usage
+The client requires a username and password for authentication and authorization of requests unless the `env` argument is set to `local`
+at instantiation. The `local` environment is intended for development use on local machines and bypasses auth.
+
+```python
+from neris_api_client import NerisApiClient
+
+client = NerisApiClient(username="neris.user", password="*******", env="dev")
+
+# Get an organization
+org = client.get_org("FD24027240")
+```

neris_api_client-0.0.1/src/neris_api_client.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+LICENSE
+README.md
+pyproject.toml
+src/neris_api_client/__init__.py
+src/neris_api_client/client.py
+src/neris_api_client/models.py
+src/neris_api_client.egg-info/PKG-INFO
+src/neris_api_client.egg-info/SOURCES.txt
+src/neris_api_client.egg-info/dependency_links.txt
+src/neris_api_client.egg-info/requires.txt
+src/neris_api_client.egg-info/top_level.txt

neris_api_client-0.0.1/src/neris_api_client.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

neris_api_client-0.0.1/src/neris_api_client.egg-info/requires.txt

@@ -0,0 +1,5 @@
+boto3
+PyJWT
+requests
+pydantic>=2
+typing_extensions

neris_api_client-0.0.1/src/neris_api_client.egg-info/top_level.txt

@@ -0,0 +1 @@
+neris_api_client