permitstack 1.0.0__py3-none-any.whl

permitstack/errors/no_response_error.py

@@ -0,0 +1,17 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from dataclasses import dataclass
+
+
+@dataclass(unsafe_hash=True)
+class NoResponseError(Exception):
+    """Error raised when no HTTP response is received from the server."""
+
+    message: str
+
+    def __init__(self, message: str = "No response received"):
+        object.__setattr__(self, "message", message)
+        super().__init__(message)
+
+    def __str__(self):
+        return self.message

permitstack/errors/permitstackdefaulterror.py

@@ -0,0 +1,40 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+import httpx
+from typing import Optional
+from dataclasses import dataclass
+
+from permitstack.errors import PermitstackError
+
+MAX_MESSAGE_LEN = 10_000
+
+
+@dataclass(unsafe_hash=True)
+class PermitstackDefaultError(PermitstackError):
+    """The fallback error class if no more specific error class is matched."""
+
+    def __init__(
+        self, message: str, raw_response: httpx.Response, body: Optional[str] = None
+    ):
+        body_display = body or raw_response.text or '""'
+
+        if message:
+            message += ": "
+        message += f"Status {raw_response.status_code}"
+
+        headers = raw_response.headers
+        content_type = headers.get("content-type", '""')
+        if content_type != "application/json":
+            if " " in content_type:
+                content_type = f'"{content_type}"'
+            message += f" Content-Type {content_type}"
+
+        if len(body_display) > MAX_MESSAGE_LEN:
+            truncated = body_display[:MAX_MESSAGE_LEN]
+            remaining = len(body_display) - MAX_MESSAGE_LEN
+            body_display = f"{truncated}...and {remaining} more chars"
+
+        message += f". Body: {body_display}"
+        message = message.strip()
+
+        super().__init__(message, raw_response, body)

permitstack/errors/permitstackerror.py

@@ -0,0 +1,30 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+import httpx
+from typing import Optional
+from dataclasses import dataclass, field
+
+
+@dataclass(unsafe_hash=True)
+class PermitstackError(Exception):
+    """The base class for all HTTP error responses."""
+
+    message: str
+    status_code: int
+    body: str
+    headers: httpx.Headers = field(hash=False)
+    raw_response: httpx.Response = field(hash=False)
+
+    def __init__(
+        self, message: str, raw_response: httpx.Response, body: Optional[str] = None
+    ):
+        object.__setattr__(self, "message", message)
+        object.__setattr__(self, "status_code", raw_response.status_code)
+        object.__setattr__(
+            self, "body", body if body is not None else raw_response.text
+        )
+        object.__setattr__(self, "headers", raw_response.headers)
+        object.__setattr__(self, "raw_response", raw_response)
+
+    def __str__(self):
+        return self.message

permitstack/errors/responsevalidationerror.py

@@ -0,0 +1,27 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+import httpx
+from typing import Optional
+from dataclasses import dataclass
+
+from permitstack.errors import PermitstackError
+
+
+@dataclass(unsafe_hash=True)
+class ResponseValidationError(PermitstackError):
+    """Error raised when there is a type mismatch between the response data and the expected Pydantic model."""
+
+    def __init__(
+        self,
+        message: str,
+        raw_response: httpx.Response,
+        cause: Exception,
+        body: Optional[str] = None,
+    ):
+        message = f"{message}: {cause}"
+        super().__init__(message, raw_response, body)
+
+    @property
+    def cause(self):
+        """Normally the Pydantic ValidationError"""
+        return self.__cause__

permitstack/health.py

@@ -0,0 +1,171 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from .basesdk import BaseSDK
+from permitstack import errors, models, utils
+from permitstack._hooks import HookContext
+from permitstack.types import OptionalNullable, UNSET
+from permitstack.utils import get_security_from_env
+from permitstack.utils.unmarshal_json_response import unmarshal_json_response
+from typing import Any, Mapping, Optional
+
+
+class Health(BaseSDK):
+    r"""Service health checks"""
+
+    def health_check(
+        self,
+        *,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> Any:
+        r"""Health Check
+
+        :param retries: Override the default retry configuration for this method
+        :param server_url: Override the default server URL for this method
+        :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
+        :param http_headers: Additional headers to set or replace on requests.
+        """
+        base_url = None
+        url_variables = None
+        if timeout_ms is None:
+            timeout_ms = self.sdk_configuration.timeout_ms
+
+        if server_url is not None:
+            base_url = server_url
+        else:
+            base_url = self._get_url(base_url, url_variables)
+        req = self._build_request(
+            method="GET",
+            path="/health",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=None,
+            request_body_required=False,
+            request_has_path_params=False,
+            request_has_query_params=True,
+            user_agent_header="user-agent",
+            accept_header_value="application/json",
+            http_headers=http_headers,
+            security=self.sdk_configuration.security,
+            allow_empty_value=None,
+            timeout_ms=timeout_ms,
+        )
+
+        if retries == UNSET:
+            if self.sdk_configuration.retry_config is not UNSET:
+                retries = self.sdk_configuration.retry_config
+
+        retry_config = None
+        if isinstance(retries, utils.RetryConfig):
+            retry_config = (retries, ["429", "500", "502", "503", "504"])
+
+        http_res = self.do_request(
+            hook_ctx=HookContext(
+                config=self.sdk_configuration,
+                base_url=base_url or "",
+                operation_id="health_check",
+                oauth2_scopes=None,
+                security_source=get_security_from_env(
+                    self.sdk_configuration.security, models.Security
+                ),
+            ),
+            request=req,
+            is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c),
+            retry_config=retry_config,
+        )
+
+        if utils.match_response(http_res, "200", "application/json"):
+            return unmarshal_json_response(Any, http_res)
+        if utils.match_response(http_res, "4XX", "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.PermitstackDefaultError(
+                "API error occurred", http_res, http_res_text
+            )
+        if utils.match_response(http_res, "5XX", "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.PermitstackDefaultError(
+                "API error occurred", http_res, http_res_text
+            )
+
+        raise errors.PermitstackDefaultError("Unexpected response received", http_res)
+
+    async def health_check_async(
+        self,
+        *,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> Any:
+        r"""Health Check
+
+        :param retries: Override the default retry configuration for this method
+        :param server_url: Override the default server URL for this method
+        :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
+        :param http_headers: Additional headers to set or replace on requests.
+        """
+        base_url = None
+        url_variables = None
+        if timeout_ms is None:
+            timeout_ms = self.sdk_configuration.timeout_ms
+
+        if server_url is not None:
+            base_url = server_url
+        else:
+            base_url = self._get_url(base_url, url_variables)
+        req = self._build_request_async(
+            method="GET",
+            path="/health",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=None,
+            request_body_required=False,
+            request_has_path_params=False,
+            request_has_query_params=True,
+            user_agent_header="user-agent",
+            accept_header_value="application/json",
+            http_headers=http_headers,
+            security=self.sdk_configuration.security,
+            allow_empty_value=None,
+            timeout_ms=timeout_ms,
+        )
+
+        if retries == UNSET:
+            if self.sdk_configuration.retry_config is not UNSET:
+                retries = self.sdk_configuration.retry_config
+
+        retry_config = None
+        if isinstance(retries, utils.RetryConfig):
+            retry_config = (retries, ["429", "500", "502", "503", "504"])
+
+        http_res = await self.do_request_async(
+            hook_ctx=HookContext(
+                config=self.sdk_configuration,
+                base_url=base_url or "",
+                operation_id="health_check",
+                oauth2_scopes=None,
+                security_source=get_security_from_env(
+                    self.sdk_configuration.security, models.Security
+                ),
+            ),
+            request=req,
+            is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c),
+            retry_config=retry_config,
+        )
+
+        if utils.match_response(http_res, "200", "application/json"):
+            return unmarshal_json_response(Any, http_res)
+        if utils.match_response(http_res, "4XX", "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise errors.PermitstackDefaultError(
+                "API error occurred", http_res, http_res_text
+            )
+        if utils.match_response(http_res, "5XX", "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise errors.PermitstackDefaultError(
+                "API error occurred", http_res, http_res_text
+            )
+
+        raise errors.PermitstackDefaultError("Unexpected response received", http_res)

permitstack/httpclient.py

@@ -0,0 +1,125 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+# pyright: reportReturnType = false
+import asyncio
+from typing_extensions import Protocol, runtime_checkable
+import httpx
+from typing import Any, Optional, Union
+
+
+@runtime_checkable
+class HttpClient(Protocol):
+    def send(
+        self,
+        request: httpx.Request,
+        *,
+        stream: bool = False,
+        auth: Union[
+            httpx._types.AuthTypes, httpx._client.UseClientDefault, None
+        ] = httpx.USE_CLIENT_DEFAULT,
+        follow_redirects: Union[
+            bool, httpx._client.UseClientDefault
+        ] = httpx.USE_CLIENT_DEFAULT,
+    ) -> httpx.Response:
+        pass
+
+    def build_request(
+        self,
+        method: str,
+        url: httpx._types.URLTypes,
+        *,
+        content: Optional[httpx._types.RequestContent] = None,
+        data: Optional[httpx._types.RequestData] = None,
+        files: Optional[httpx._types.RequestFiles] = None,
+        json: Optional[Any] = None,
+        params: Optional[httpx._types.QueryParamTypes] = None,
+        headers: Optional[httpx._types.HeaderTypes] = None,
+        cookies: Optional[httpx._types.CookieTypes] = None,
+        timeout: Union[
+            httpx._types.TimeoutTypes, httpx._client.UseClientDefault
+        ] = httpx.USE_CLIENT_DEFAULT,
+        extensions: Optional[httpx._types.RequestExtensions] = None,
+    ) -> httpx.Request:
+        pass
+
+    def close(self) -> None:
+        pass
+
+
+@runtime_checkable
+class AsyncHttpClient(Protocol):
+    async def send(
+        self,
+        request: httpx.Request,
+        *,
+        stream: bool = False,
+        auth: Union[
+            httpx._types.AuthTypes, httpx._client.UseClientDefault, None
+        ] = httpx.USE_CLIENT_DEFAULT,
+        follow_redirects: Union[
+            bool, httpx._client.UseClientDefault
+        ] = httpx.USE_CLIENT_DEFAULT,
+    ) -> httpx.Response:
+        pass
+
+    def build_request(
+        self,
+        method: str,
+        url: httpx._types.URLTypes,
+        *,
+        content: Optional[httpx._types.RequestContent] = None,
+        data: Optional[httpx._types.RequestData] = None,
+        files: Optional[httpx._types.RequestFiles] = None,
+        json: Optional[Any] = None,
+        params: Optional[httpx._types.QueryParamTypes] = None,
+        headers: Optional[httpx._types.HeaderTypes] = None,
+        cookies: Optional[httpx._types.CookieTypes] = None,
+        timeout: Union[
+            httpx._types.TimeoutTypes, httpx._client.UseClientDefault
+        ] = httpx.USE_CLIENT_DEFAULT,
+        extensions: Optional[httpx._types.RequestExtensions] = None,
+    ) -> httpx.Request:
+        pass
+
+    async def aclose(self) -> None:
+        pass
+
+
+class ClientOwner(Protocol):
+    client: Union[HttpClient, None]
+    async_client: Union[AsyncHttpClient, None]
+
+
+def close_clients(
+    owner: ClientOwner,
+    sync_client: Union[HttpClient, None],
+    sync_client_supplied: bool,
+    async_client: Union[AsyncHttpClient, None],
+    async_client_supplied: bool,
+) -> None:
+    """
+    A finalizer function that is meant to be used with weakref.finalize to close
+    httpx clients used by an SDK so that underlying resources can be garbage
+    collected.
+    """
+
+    # Unset the client/async_client properties so there are no more references
+    # to them from the owning SDK instance and they can be reaped.
+    owner.client = None
+    owner.async_client = None
+    if sync_client is not None and not sync_client_supplied:
+        try:
+            sync_client.close()
+        except Exception:
+            pass
+
+    if async_client is not None and not async_client_supplied:
+        try:
+            loop = asyncio.get_running_loop()
+            asyncio.run_coroutine_threadsafe(async_client.aclose(), loop)
+        except RuntimeError:
+            try:
+                asyncio.run(async_client.aclose())
+            except RuntimeError:
+                # best effort
+                pass

permitstack/models/__init__.py

@@ -0,0 +1,158 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from typing import Any, TYPE_CHECKING
+
+from permitstack.utils.dynamic_imports import lazy_getattr, lazy_dir
+
+if TYPE_CHECKING:
+    from .contractorprofile import ContractorProfile, ContractorProfileTypedDict
+    from .contractorsearchresponse import (
+        ContractorSearchResponse,
+        ContractorSearchResponseTypedDict,
+    )
+    from .contractorsummary import ContractorSummary, ContractorSummaryTypedDict
+    from .delete_webhookop import DeleteWebhookRequest, DeleteWebhookRequestTypedDict
+    from .export_permits_csvop import (
+        ExportPermitsCsvRequest,
+        ExportPermitsCsvRequestTypedDict,
+    )
+    from .get_contractor_permitsop import (
+        GetContractorPermitsRequest,
+        GetContractorPermitsRequestTypedDict,
+    )
+    from .get_contractorop import GetContractorRequest, GetContractorRequestTypedDict
+    from .get_permitop import GetPermitRequest, GetPermitRequestTypedDict
+    from .get_permits_by_addressop import (
+        GetPermitsByAddressRequest,
+        GetPermitsByAddressRequestTypedDict,
+    )
+    from .get_property_historyop import (
+        GetPropertyHistoryRequest,
+        GetPropertyHistoryRequestTypedDict,
+    )
+    from .permitcategory import PermitCategory
+    from .permitdetail import PermitDetail, PermitDetailTypedDict
+    from .permitsearchresponse import (
+        PermitSearchResponse,
+        PermitSearchResponseTypedDict,
+    )
+    from .permitstatus import PermitStatus
+    from .permitsummary import PermitSummary, PermitSummaryTypedDict
+    from .propertytype import PropertyType
+    from .search_contractorsop import (
+        SearchContractorsRequest,
+        SearchContractorsRequestTypedDict,
+    )
+    from .search_permitsop import SearchPermitsRequest, SearchPermitsRequestTypedDict
+    from .security import Security, SecurityTypedDict
+    from .validationerror import (
+        Context,
+        ContextTypedDict,
+        Loc,
+        LocTypedDict,
+        ValidationError,
+        ValidationErrorTypedDict,
+    )
+    from .webhookcreate import WebhookCreate, WebhookCreateTypedDict
+
+__all__ = [
+    "Context",
+    "ContextTypedDict",
+    "ContractorProfile",
+    "ContractorProfileTypedDict",
+    "ContractorSearchResponse",
+    "ContractorSearchResponseTypedDict",
+    "ContractorSummary",
+    "ContractorSummaryTypedDict",
+    "DeleteWebhookRequest",
+    "DeleteWebhookRequestTypedDict",
+    "ExportPermitsCsvRequest",
+    "ExportPermitsCsvRequestTypedDict",
+    "GetContractorPermitsRequest",
+    "GetContractorPermitsRequestTypedDict",
+    "GetContractorRequest",
+    "GetContractorRequestTypedDict",
+    "GetPermitRequest",
+    "GetPermitRequestTypedDict",
+    "GetPermitsByAddressRequest",
+    "GetPermitsByAddressRequestTypedDict",
+    "GetPropertyHistoryRequest",
+    "GetPropertyHistoryRequestTypedDict",
+    "Loc",
+    "LocTypedDict",
+    "PermitCategory",
+    "PermitDetail",
+    "PermitDetailTypedDict",
+    "PermitSearchResponse",
+    "PermitSearchResponseTypedDict",
+    "PermitStatus",
+    "PermitSummary",
+    "PermitSummaryTypedDict",
+    "PropertyType",
+    "SearchContractorsRequest",
+    "SearchContractorsRequestTypedDict",
+    "SearchPermitsRequest",
+    "SearchPermitsRequestTypedDict",
+    "Security",
+    "SecurityTypedDict",
+    "ValidationError",
+    "ValidationErrorTypedDict",
+    "WebhookCreate",
+    "WebhookCreateTypedDict",
+]
+
+_dynamic_imports: dict[str, str] = {
+    "ContractorProfile": ".contractorprofile",
+    "ContractorProfileTypedDict": ".contractorprofile",
+    "ContractorSearchResponse": ".contractorsearchresponse",
+    "ContractorSearchResponseTypedDict": ".contractorsearchresponse",
+    "ContractorSummary": ".contractorsummary",
+    "ContractorSummaryTypedDict": ".contractorsummary",
+    "DeleteWebhookRequest": ".delete_webhookop",
+    "DeleteWebhookRequestTypedDict": ".delete_webhookop",
+    "ExportPermitsCsvRequest": ".export_permits_csvop",
+    "ExportPermitsCsvRequestTypedDict": ".export_permits_csvop",
+    "GetContractorPermitsRequest": ".get_contractor_permitsop",
+    "GetContractorPermitsRequestTypedDict": ".get_contractor_permitsop",
+    "GetContractorRequest": ".get_contractorop",
+    "GetContractorRequestTypedDict": ".get_contractorop",
+    "GetPermitRequest": ".get_permitop",
+    "GetPermitRequestTypedDict": ".get_permitop",
+    "GetPermitsByAddressRequest": ".get_permits_by_addressop",
+    "GetPermitsByAddressRequestTypedDict": ".get_permits_by_addressop",
+    "GetPropertyHistoryRequest": ".get_property_historyop",
+    "GetPropertyHistoryRequestTypedDict": ".get_property_historyop",
+    "PermitCategory": ".permitcategory",
+    "PermitDetail": ".permitdetail",
+    "PermitDetailTypedDict": ".permitdetail",
+    "PermitSearchResponse": ".permitsearchresponse",
+    "PermitSearchResponseTypedDict": ".permitsearchresponse",
+    "PermitStatus": ".permitstatus",
+    "PermitSummary": ".permitsummary",
+    "PermitSummaryTypedDict": ".permitsummary",
+    "PropertyType": ".propertytype",
+    "SearchContractorsRequest": ".search_contractorsop",
+    "SearchContractorsRequestTypedDict": ".search_contractorsop",
+    "SearchPermitsRequest": ".search_permitsop",
+    "SearchPermitsRequestTypedDict": ".search_permitsop",
+    "Security": ".security",
+    "SecurityTypedDict": ".security",
+    "Context": ".validationerror",
+    "ContextTypedDict": ".validationerror",
+    "Loc": ".validationerror",
+    "LocTypedDict": ".validationerror",
+    "ValidationError": ".validationerror",
+    "ValidationErrorTypedDict": ".validationerror",
+    "WebhookCreate": ".webhookcreate",
+    "WebhookCreateTypedDict": ".webhookcreate",
+}
+
+
+def __getattr__(attr_name: str) -> Any:
+    return lazy_getattr(
+        attr_name, package=__package__, dynamic_imports=_dynamic_imports
+    )
+
+
+def __dir__():
+    return lazy_dir(dynamic_imports=_dynamic_imports)

permitstack/models/contractorprofile.py

@@ -0,0 +1,108 @@
+"""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 ContractorProfileTypedDict(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]]
+    phone: Nullable[str]
+    email: Nullable[str]
+    address: Nullable[str]
+    zip_code: Nullable[str]
+    recent_categories: NotRequired[Nullable[List[str]]]
+    avg_project_value: NotRequired[Nullable[float]]
+
+
+class ContractorProfile(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]]
+
+    phone: Nullable[str]
+
+    email: Nullable[str]
+
+    address: Nullable[str]
+
+    zip_code: Nullable[str]
+
+    recent_categories: OptionalNullable[List[str]] = UNSET
+
+    avg_project_value: OptionalNullable[float] = UNSET
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["recent_categories", "avg_project_value"])
+        nullable_fields = set(
+            [
+                "license_number",
+                "license_state",
+                "city",
+                "state",
+                "first_permit_date",
+                "last_permit_date",
+                "specialties",
+                "phone",
+                "email",
+                "address",
+                "zip_code",
+                "recent_categories",
+                "avg_project_value",
+            ]
+        )
+        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