zillow-rapidapi-client 0.1.3__py3-none-any.whl

zillow_rapidapi_client/httpclient.py

@@ -0,0 +1,134 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+# pyright: reportReturnType = false
+import asyncio
+from concurrent.futures import ThreadPoolExecutor
+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],
+    async_client: Union[AsyncHttpClient, None],
+) -> 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:
+        try:
+            sync_client.close()
+        except Exception:
+            pass
+
+    if async_client is not None:
+        is_async = False
+        try:
+            asyncio.get_running_loop()
+            is_async = True
+        except RuntimeError:
+            pass
+
+        try:
+            # If this function is called in an async loop then start another
+            # loop in a separate thread to close the async http client.
+            if is_async:
+                with ThreadPoolExecutor(max_workers=1) as executor:
+                    future = executor.submit(asyncio.run, async_client.aclose())
+                    future.result()
+            else:
+                asyncio.run(async_client.aclose())
+        except Exception:
+            pass

zillow_rapidapi_client/models/__init__.py

@@ -0,0 +1,40 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from .apierror import APIError
+from .property import (
+    ListingStatus,
+    ListingSubType,
+    ListingSubTypeTypedDict,
+    Property,
+    PropertyType,
+    PropertyTypedDict,
+)
+from .propertyextendedsearchop import (
+    HomeType,
+    PropertyExtendedSearchRequest,
+    PropertyExtendedSearchRequestTypedDict,
+    Sort,
+    StatusType,
+)
+from .propertysearchresponse import (
+    PropertySearchResponse,
+    PropertySearchResponseTypedDict,
+)
+
+
+__all__ = [
+    "APIError",
+    "HomeType",
+    "ListingStatus",
+    "ListingSubType",
+    "ListingSubTypeTypedDict",
+    "Property",
+    "PropertyExtendedSearchRequest",
+    "PropertyExtendedSearchRequestTypedDict",
+    "PropertySearchResponse",
+    "PropertySearchResponseTypedDict",
+    "PropertyType",
+    "PropertyTypedDict",
+    "Sort",
+    "StatusType",
+]

zillow_rapidapi_client/models/apierror.py

@@ -0,0 +1,22 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from dataclasses import dataclass
+from typing import Optional
+import httpx
+
+
+@dataclass
+class APIError(Exception):
+    """Represents an error returned by the API."""
+
+    message: str
+    status_code: int = -1
+    body: str = ""
+    raw_response: Optional[httpx.Response] = None
+
+    def __str__(self):
+        body = ""
+        if len(self.body) > 0:
+            body = f"\n{self.body}"
+
+        return f"{self.message}: Status {self.status_code}{body}"

zillow_rapidapi_client/models/property.py

@@ -0,0 +1,163 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from datetime import datetime
+from enum import Enum
+import pydantic
+from pydantic import model_serializer
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+from zillow_rapidapi_client.types import (
+    BaseModel,
+    Nullable,
+    OptionalNullable,
+    UNSET,
+    UNSET_SENTINEL,
+)
+
+
+class PropertyType(str, Enum):
+    SINGLE_FAMILY = "SINGLE_FAMILY"
+    MULTI_FAMILY = "MULTI_FAMILY"
+    CONDO = "CONDO"
+    TOWNHOUSE = "TOWNHOUSE"
+    APARTMENT = "APARTMENT"
+    LAND = "LAND"
+
+
+class ListingStatus(str, Enum):
+    FOR_SALE = "FOR_SALE"
+    PENDING = "PENDING"
+    SOLD = "SOLD"
+
+
+class ListingSubTypeTypedDict(TypedDict):
+    is_fsba: NotRequired[bool]
+
+
+class ListingSubType(BaseModel):
+    is_fsba: Annotated[Optional[bool], pydantic.Field(alias="is_FSBA")] = None
+
+
+class PropertyTypedDict(TypedDict):
+    date_sold: NotRequired[Nullable[datetime]]
+    property_type: NotRequired[PropertyType]
+    lot_area_value: NotRequired[float]
+    address: NotRequired[str]
+    img_src: NotRequired[str]
+    price: NotRequired[float]
+    bedrooms: NotRequired[int]
+    longitude: NotRequired[float]
+    latitude: NotRequired[float]
+    listing_status: NotRequired[ListingStatus]
+    zpid: NotRequired[str]
+    listing_sub_type: NotRequired[ListingSubTypeTypedDict]
+    days_on_zillow: NotRequired[int]
+    bathrooms: NotRequired[float]
+    living_area: NotRequired[int]
+    country: NotRequired[str]
+    currency: NotRequired[str]
+    lot_area_unit: NotRequired[str]
+    has_image: NotRequired[bool]
+
+
+class Property(BaseModel):
+    date_sold: Annotated[
+        OptionalNullable[datetime], pydantic.Field(alias="dateSold")
+    ] = UNSET
+
+    property_type: Annotated[
+        Optional[PropertyType], pydantic.Field(alias="propertyType")
+    ] = None
+
+    lot_area_value: Annotated[Optional[float], pydantic.Field(alias="lotAreaValue")] = (
+        None
+    )
+
+    address: Optional[str] = None
+
+    img_src: Annotated[Optional[str], pydantic.Field(alias="imgSrc")] = None
+
+    price: Optional[float] = None
+
+    bedrooms: Optional[int] = None
+
+    longitude: Optional[float] = None
+
+    latitude: Optional[float] = None
+
+    listing_status: Annotated[
+        Optional[ListingStatus], pydantic.Field(alias="listingStatus")
+    ] = None
+
+    zpid: Optional[str] = None
+
+    listing_sub_type: Annotated[
+        Optional[ListingSubType], pydantic.Field(alias="listingSubType")
+    ] = None
+
+    days_on_zillow: Annotated[Optional[int], pydantic.Field(alias="daysOnZillow")] = (
+        None
+    )
+
+    bathrooms: Optional[float] = None
+
+    living_area: Annotated[Optional[int], pydantic.Field(alias="livingArea")] = None
+
+    country: Optional[str] = None
+
+    currency: Optional[str] = None
+
+    lot_area_unit: Annotated[Optional[str], pydantic.Field(alias="lotAreaUnit")] = None
+
+    has_image: Annotated[Optional[bool], pydantic.Field(alias="hasImage")] = None
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = [
+            "dateSold",
+            "propertyType",
+            "lotAreaValue",
+            "address",
+            "imgSrc",
+            "price",
+            "bedrooms",
+            "longitude",
+            "latitude",
+            "listingStatus",
+            "zpid",
+            "listingSubType",
+            "daysOnZillow",
+            "bathrooms",
+            "livingArea",
+            "country",
+            "currency",
+            "lotAreaUnit",
+            "hasImage",
+        ]
+        nullable_fields = ["dateSold"]
+        null_default_fields = []
+
+        serialized = handler(self)
+
+        m = {}
+
+        for n, f in self.model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+            serialized.pop(k, None)
+
+            optional_nullable = k in optional_fields and k in nullable_fields
+            is_set = (
+                self.__pydantic_fields_set__.intersection({n})
+                or k in null_default_fields
+            )  # pylint: disable=no-member
+
+            if val is not None and val != UNSET_SENTINEL:
+                m[k] = val
+            elif val != UNSET_SENTINEL and (
+                not k in optional_fields or (optional_nullable and is_set)
+            ):
+                m[k] = val
+
+        return m

zillow_rapidapi_client/models/propertyextendedsearchop.py

@@ -0,0 +1,106 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+import pydantic
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+from zillow_rapidapi_client.types import BaseModel
+from zillow_rapidapi_client.utils import FieldMetadata, QueryParamMetadata
+
+
+class StatusType(str, Enum):
+    r"""Property status type."""
+
+    FOR_SALE = "ForSale"
+    RECENTLY_SOLD = "RecentlySold"
+    FOR_RENT = "ForRent"
+
+
+class HomeType(str, Enum):
+    r"""Property type. Comma-separated list."""
+
+    HOUSES = "Houses"
+    APARTMENTS_CONDOS_CO_OPS = "Apartments_Condos_Co-ops"
+    MULTI_FAMILY = "Multi-family"
+    APARTMENTS = "Apartments"
+    MANUFACTURED = "Manufactured"
+    CONDOS = "Condos"
+    LOTS_LAND = "LotsLand"
+    TOWNHOMES = "Townhomes"
+
+
+class Sort(str, Enum):
+    r"""Sorting order."""
+
+    HOMES_FOR_YOU = "Homes_for_You"
+    PRICE_HIGH_LOW = "Price_High_Low"
+    PRICE_LOW_HIGH = "Price_Low_High"
+    NEWEST = "Newest"
+    BEDROOMS = "Bedrooms"
+    BATHROOMS = "Bathrooms"
+    SQUARE_FEET = "Square_Feet"
+    LOT_SIZE = "Lot_Size"
+
+
+class PropertyExtendedSearchRequestTypedDict(TypedDict):
+    location: NotRequired[str]
+    r"""Location details (address, county, neighborhood, or Zip code). Required if polygon or coordinates are empty."""
+    page: NotRequired[int]
+    r"""Page number for paginated results. Max value is 20."""
+    status_type: NotRequired[StatusType]
+    r"""Property status type."""
+    home_type: NotRequired[HomeType]
+    r"""Property type. Comma-separated list."""
+    sort: NotRequired[Sort]
+    r"""Sorting order."""
+    min_price: NotRequired[float]
+    r"""Minimum price filter."""
+    max_price: NotRequired[float]
+    r"""Maximum price filter."""
+
+
+class PropertyExtendedSearchRequest(BaseModel):
+    location: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Location details (address, county, neighborhood, or Zip code). Required if polygon or coordinates are empty."""
+
+    page: Annotated[
+        Optional[int],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Page number for paginated results. Max value is 20."""
+
+    status_type: Annotated[
+        Optional[StatusType],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Property status type."""
+
+    home_type: Annotated[
+        Optional[HomeType],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Property type. Comma-separated list."""
+
+    sort: Annotated[
+        Optional[Sort],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Sorting order."""
+
+    min_price: Annotated[
+        Optional[float],
+        pydantic.Field(alias="minPrice"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Minimum price filter."""
+
+    max_price: Annotated[
+        Optional[float],
+        pydantic.Field(alias="maxPrice"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Maximum price filter."""

zillow_rapidapi_client/models/propertysearchresponse.py

@@ -0,0 +1,32 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .property import Property, PropertyTypedDict
+import pydantic
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+from zillow_rapidapi_client.types import BaseModel
+
+
+class PropertySearchResponseTypedDict(TypedDict):
+    props: NotRequired[List[PropertyTypedDict]]
+    results_per_page: NotRequired[int]
+    total_pages: NotRequired[int]
+    total_result_count: NotRequired[int]
+    current_page: NotRequired[int]
+
+
+class PropertySearchResponse(BaseModel):
+    props: Optional[List[Property]] = None
+
+    results_per_page: Annotated[
+        Optional[int], pydantic.Field(alias="resultsPerPage")
+    ] = None
+
+    total_pages: Annotated[Optional[int], pydantic.Field(alias="totalPages")] = None
+
+    total_result_count: Annotated[
+        Optional[int], pydantic.Field(alias="totalResultCount")
+    ] = None
+
+    current_page: Annotated[Optional[int], pydantic.Field(alias="currentPage")] = None