permitstack 1.0.0__py3-none-any.whl

permitstack/models/contractorsearchresponse.py

@@ -0,0 +1,24 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .contractorsummary import ContractorSummary, ContractorSummaryTypedDict
+from permitstack.types import BaseModel
+from typing import List
+from typing_extensions import TypedDict
+
+
+class ContractorSearchResponseTypedDict(TypedDict):
+    total: int
+    page: int
+    per_page: int
+    results: List[ContractorSummaryTypedDict]
+
+
+class ContractorSearchResponse(BaseModel):
+    total: int
+
+    page: int
+
+    per_page: int
+
+    results: List[ContractorSummary]

permitstack/models/contractorsummary.py

@@ -0,0 +1,57 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from datetime import date
+from permitstack.types import BaseModel, Nullable, UNSET_SENTINEL
+from pydantic import model_serializer
+from typing import List
+from typing_extensions import TypedDict
+
+
+class ContractorSummaryTypedDict(TypedDict):
+    id: str
+    name: str
+    license_number: Nullable[str]
+    license_state: Nullable[str]
+    city: Nullable[str]
+    state: Nullable[str]
+    total_permits: int
+    first_permit_date: Nullable[date]
+    last_permit_date: Nullable[date]
+    specialties: Nullable[List[str]]
+
+
+class ContractorSummary(BaseModel):
+    id: str
+
+    name: str
+
+    license_number: Nullable[str]
+
+    license_state: Nullable[str]
+
+    city: Nullable[str]
+
+    state: Nullable[str]
+
+    total_permits: int
+
+    first_permit_date: Nullable[date]
+
+    last_permit_date: Nullable[date]
+
+    specialties: Nullable[List[str]]
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k, serialized.get(n))
+
+            if val != UNSET_SENTINEL:
+                m[k] = val
+
+        return m

permitstack/models/delete_webhookop.py

@@ -0,0 +1,16 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from permitstack.types import BaseModel
+from permitstack.utils import FieldMetadata, PathParamMetadata
+from typing_extensions import Annotated, TypedDict
+
+
+class DeleteWebhookRequestTypedDict(TypedDict):
+    webhook_id: str
+
+
+class DeleteWebhookRequest(BaseModel):
+    webhook_id: Annotated[
+        str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
+    ]

permitstack/models/export_permits_csvop.py

@@ -0,0 +1,98 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from permitstack.types import (
+    BaseModel,
+    Nullable,
+    OptionalNullable,
+    UNSET,
+    UNSET_SENTINEL,
+)
+from permitstack.utils import FieldMetadata, QueryParamMetadata
+from pydantic import model_serializer
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class ExportPermitsCsvRequestTypedDict(TypedDict):
+    city: NotRequired[Nullable[str]]
+    state: NotRequired[Nullable[str]]
+    category: NotRequired[Nullable[str]]
+    zip_code: NotRequired[Nullable[str]]
+    filed_after: NotRequired[Nullable[str]]
+    filed_before: NotRequired[Nullable[str]]
+    limit: NotRequired[int]
+
+
+class ExportPermitsCsvRequest(BaseModel):
+    city: Annotated[
+        OptionalNullable[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UNSET
+
+    state: Annotated[
+        OptionalNullable[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UNSET
+
+    category: Annotated[
+        OptionalNullable[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UNSET
+
+    zip_code: Annotated[
+        OptionalNullable[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UNSET
+
+    filed_after: Annotated[
+        OptionalNullable[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UNSET
+
+    filed_before: Annotated[
+        OptionalNullable[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UNSET
+
+    limit: Annotated[
+        Optional[int],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = 10000
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            [
+                "city",
+                "state",
+                "category",
+                "zip_code",
+                "filed_after",
+                "filed_before",
+                "limit",
+            ]
+        )
+        nullable_fields = set(
+            ["city", "state", "category", "zip_code", "filed_after", "filed_before"]
+        )
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k, serialized.get(n))
+            is_nullable_and_explicitly_set = (
+                k in nullable_fields
+                and (self.__pydantic_fields_set__.intersection({n}))  # pylint: disable=no-member
+            )
+
+            if val != UNSET_SENTINEL:
+                if (
+                    val is not None
+                    or k not in optional_fields
+                    or is_nullable_and_explicitly_set
+                ):
+                    m[k] = val
+
+        return m

permitstack/models/get_contractor_permitsop.py

@@ -0,0 +1,46 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from permitstack.types import BaseModel, UNSET_SENTINEL
+from permitstack.utils import FieldMetadata, PathParamMetadata, QueryParamMetadata
+from pydantic import model_serializer
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class GetContractorPermitsRequestTypedDict(TypedDict):
+    contractor_id: str
+    page: NotRequired[int]
+    per_page: NotRequired[int]
+
+
+class GetContractorPermitsRequest(BaseModel):
+    contractor_id: Annotated[
+        str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
+    ]
+
+    page: Annotated[
+        Optional[int],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = 1
+
+    per_page: Annotated[
+        Optional[int],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = 25
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["page", "per_page"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k, serialized.get(n))
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m

permitstack/models/get_contractorop.py

@@ -0,0 +1,16 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from permitstack.types import BaseModel
+from permitstack.utils import FieldMetadata, PathParamMetadata
+from typing_extensions import Annotated, TypedDict
+
+
+class GetContractorRequestTypedDict(TypedDict):
+    contractor_id: str
+
+
+class GetContractorRequest(BaseModel):
+    contractor_id: Annotated[
+        str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
+    ]

permitstack/models/get_permitop.py

@@ -0,0 +1,16 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from permitstack.types import BaseModel
+from permitstack.utils import FieldMetadata, PathParamMetadata
+from typing_extensions import Annotated, TypedDict
+
+
+class GetPermitRequestTypedDict(TypedDict):
+    permit_id: str
+
+
+class GetPermitRequest(BaseModel):
+    permit_id: Annotated[
+        str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
+    ]

permitstack/models/get_permits_by_addressop.py

@@ -0,0 +1,46 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from permitstack.types import BaseModel, UNSET_SENTINEL
+from permitstack.utils import FieldMetadata, PathParamMetadata, QueryParamMetadata
+from pydantic import model_serializer
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class GetPermitsByAddressRequestTypedDict(TypedDict):
+    address: str
+    page: NotRequired[int]
+    per_page: NotRequired[int]
+
+
+class GetPermitsByAddressRequest(BaseModel):
+    address: Annotated[
+        str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
+    ]
+
+    page: Annotated[
+        Optional[int],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = 1
+
+    per_page: Annotated[
+        Optional[int],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = 25
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["page", "per_page"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k, serialized.get(n))
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m

permitstack/models/get_property_historyop.py

@@ -0,0 +1,18 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from permitstack.types import BaseModel
+from permitstack.utils import FieldMetadata, QueryParamMetadata
+from typing_extensions import Annotated, TypedDict
+
+
+class GetPropertyHistoryRequestTypedDict(TypedDict):
+    address: str
+    r"""Street address to look up"""
+
+
+class GetPropertyHistoryRequest(BaseModel):
+    address: Annotated[
+        str, FieldMetadata(query=QueryParamMetadata(style="form", explode=True))
+    ]
+    r"""Street address to look up"""

permitstack/models/permitcategory.py

@@ -0,0 +1,27 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from typing import Literal
+
+
+PermitCategory = Literal[
+    "new_construction",
+    "renovation",
+    "demolition",
+    "electrical",
+    "plumbing",
+    "mechanical",
+    "roofing",
+    "solar",
+    "ev_charger",
+    "hvac",
+    "fire_alarm",
+    "sign",
+    "fence",
+    "pool",
+    "foundation",
+    "addition",
+    "interior_remodel",
+    "grading",
+    "other",
+]

permitstack/models/permitdetail.py

@@ -0,0 +1,164 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from datetime import date
+from permitstack.types import (
+    BaseModel,
+    Nullable,
+    OptionalNullable,
+    UNSET,
+    UNSET_SENTINEL,
+)
+from pydantic import model_serializer
+from typing import List
+from typing_extensions import NotRequired, TypedDict
+
+
+class PermitDetailTypedDict(TypedDict):
+    id: str
+    permit_number: Nullable[str]
+    status: str
+    category: str
+    tags: Nullable[List[str]]
+    property_type: str
+    address_street: Nullable[str]
+    address_city: Nullable[str]
+    address_state: Nullable[str]
+    address_zip: Nullable[str]
+    description_raw: Nullable[str]
+    estimated_value: Nullable[float]
+    date_filed: Nullable[date]
+    date_issued: Nullable[date]
+    date_completed: Nullable[date]
+    date_expired: Nullable[date]
+    fee_amount: Nullable[float]
+    stories: Nullable[int]
+    units: Nullable[int]
+    square_footage: Nullable[float]
+    applicant_name: Nullable[str]
+    owner_name: Nullable[str]
+    contractor_name: NotRequired[Nullable[str]]
+    jurisdiction_name: NotRequired[Nullable[str]]
+    latitude: NotRequired[Nullable[float]]
+    longitude: NotRequired[Nullable[float]]
+    contractor_license: NotRequired[Nullable[str]]
+    created_at: NotRequired[Nullable[str]]
+
+
+class PermitDetail(BaseModel):
+    id: str
+
+    permit_number: Nullable[str]
+
+    status: str
+
+    category: str
+
+    tags: Nullable[List[str]]
+
+    property_type: str
+
+    address_street: Nullable[str]
+
+    address_city: Nullable[str]
+
+    address_state: Nullable[str]
+
+    address_zip: Nullable[str]
+
+    description_raw: Nullable[str]
+
+    estimated_value: Nullable[float]
+
+    date_filed: Nullable[date]
+
+    date_issued: Nullable[date]
+
+    date_completed: Nullable[date]
+
+    date_expired: Nullable[date]
+
+    fee_amount: Nullable[float]
+
+    stories: Nullable[int]
+
+    units: Nullable[int]
+
+    square_footage: Nullable[float]
+
+    applicant_name: Nullable[str]
+
+    owner_name: Nullable[str]
+
+    contractor_name: OptionalNullable[str] = UNSET
+
+    jurisdiction_name: OptionalNullable[str] = UNSET
+
+    latitude: OptionalNullable[float] = UNSET
+
+    longitude: OptionalNullable[float] = UNSET
+
+    contractor_license: OptionalNullable[str] = UNSET
+
+    created_at: OptionalNullable[str] = UNSET
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            [
+                "contractor_name",
+                "jurisdiction_name",
+                "latitude",
+                "longitude",
+                "contractor_license",
+                "created_at",
+            ]
+        )
+        nullable_fields = set(
+            [
+                "permit_number",
+                "tags",
+                "address_street",
+                "address_city",
+                "address_state",
+                "address_zip",
+                "description_raw",
+                "estimated_value",
+                "date_filed",
+                "date_issued",
+                "date_completed",
+                "contractor_name",
+                "jurisdiction_name",
+                "latitude",
+                "longitude",
+                "date_expired",
+                "fee_amount",
+                "stories",
+                "units",
+                "square_footage",
+                "applicant_name",
+                "owner_name",
+                "contractor_license",
+                "created_at",
+            ]
+        )
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k, serialized.get(n))
+            is_nullable_and_explicitly_set = (
+                k in nullable_fields
+                and (self.__pydantic_fields_set__.intersection({n}))  # pylint: disable=no-member
+            )
+
+            if val != UNSET_SENTINEL:
+                if (
+                    val is not None
+                    or k not in optional_fields
+                    or is_nullable_and_explicitly_set
+                ):
+                    m[k] = val
+
+        return m

permitstack/models/permitsearchresponse.py

@@ -0,0 +1,24 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .permitsummary import PermitSummary, PermitSummaryTypedDict
+from permitstack.types import BaseModel
+from typing import List
+from typing_extensions import TypedDict
+
+
+class PermitSearchResponseTypedDict(TypedDict):
+    total: int
+    page: int
+    per_page: int
+    results: List[PermitSummaryTypedDict]
+
+
+class PermitSearchResponse(BaseModel):
+    total: int
+
+    page: int
+
+    per_page: int
+
+    results: List[PermitSummary]

permitstack/models/permitstatus.py

@@ -0,0 +1,16 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from typing import Literal
+
+
+PermitStatus = Literal[
+    "filed",
+    "issued",
+    "in_progress",
+    "final",
+    "expired",
+    "cancelled",
+    "revoked",
+    "unknown",
+]

permitstack/models/permitsummary.py

@@ -0,0 +1,121 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from datetime import date
+from permitstack.types import (
+    BaseModel,
+    Nullable,
+    OptionalNullable,
+    UNSET,
+    UNSET_SENTINEL,
+)
+from pydantic import model_serializer
+from typing import List
+from typing_extensions import NotRequired, TypedDict
+
+
+class PermitSummaryTypedDict(TypedDict):
+    id: str
+    permit_number: Nullable[str]
+    status: str
+    category: str
+    tags: Nullable[List[str]]
+    property_type: str
+    address_street: Nullable[str]
+    address_city: Nullable[str]
+    address_state: Nullable[str]
+    address_zip: Nullable[str]
+    description_raw: Nullable[str]
+    estimated_value: Nullable[float]
+    date_filed: Nullable[date]
+    date_issued: Nullable[date]
+    date_completed: Nullable[date]
+    contractor_name: NotRequired[Nullable[str]]
+    jurisdiction_name: NotRequired[Nullable[str]]
+    latitude: NotRequired[Nullable[float]]
+    longitude: NotRequired[Nullable[float]]
+
+
+class PermitSummary(BaseModel):
+    id: str
+
+    permit_number: Nullable[str]
+
+    status: str
+
+    category: str
+
+    tags: Nullable[List[str]]
+
+    property_type: str
+
+    address_street: Nullable[str]
+
+    address_city: Nullable[str]
+
+    address_state: Nullable[str]
+
+    address_zip: Nullable[str]
+
+    description_raw: Nullable[str]
+
+    estimated_value: Nullable[float]
+
+    date_filed: Nullable[date]
+
+    date_issued: Nullable[date]
+
+    date_completed: Nullable[date]
+
+    contractor_name: OptionalNullable[str] = UNSET
+
+    jurisdiction_name: OptionalNullable[str] = UNSET
+
+    latitude: OptionalNullable[float] = UNSET
+
+    longitude: OptionalNullable[float] = UNSET
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            ["contractor_name", "jurisdiction_name", "latitude", "longitude"]
+        )
+        nullable_fields = set(
+            [
+                "permit_number",
+                "tags",
+                "address_street",
+                "address_city",
+                "address_state",
+                "address_zip",
+                "description_raw",
+                "estimated_value",
+                "date_filed",
+                "date_issued",
+                "date_completed",
+                "contractor_name",
+                "jurisdiction_name",
+                "latitude",
+                "longitude",
+            ]
+        )
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k, serialized.get(n))
+            is_nullable_and_explicitly_set = (
+                k in nullable_fields
+                and (self.__pydantic_fields_set__.intersection({n}))  # pylint: disable=no-member
+            )
+
+            if val != UNSET_SENTINEL:
+                if (
+                    val is not None
+                    or k not in optional_fields
+                    or is_nullable_and_explicitly_set
+                ):
+                    m[k] = val
+
+        return m