schemas.py

from typing import Optional
from pydantic import BaseModel, Field

from .enums import ReviewSortBy


class BaseRequest(BaseModel):
    q: str = Field(..., description="The query to search for")
    gl: Optional[str] = Field(None, description="The country to search in, e.g. us, uk, ca, au, etc.")
    location: Optional[str] = Field(None, description="The location to search in, e.g. San Francisco, CA, USA")
    hl: Optional[str] = Field(None, description="The language to search in, e.g. en, es, fr, de, etc.")
    page: Optional[int] = Field(1, ge=1, description="The page number to return, first page is 1")


class SearchRequest(BaseRequest):
    tbs: Optional[str] = Field(None, description="The time period to search in, e.g. d, w, m, y")
    num: int = Field(10, le=100, description="The number of results to return, max is 100")


class AutocorrectRequest(BaseRequest):
    autocorrect: Optional[bool] = Field(True, description="Automatically correct")


class MapsRequest(BaseModel):
    q: str = Field(..., description="The query to search for")
    ll: Optional[str] = Field(None, description="The GPS position & zoom level")
    placeId: Optional[str] = Field(None, description="The place ID to search in")
    cid: Optional[str] = Field(None, description="The CID to search in")
    gl: Optional[str] = Field(None, description="The country to search in, e.g. us, uk, ca, au, etc.")
    hl: Optional[str] = Field(None, description="The language to search in, e.g. en, es, fr, de, etc.")
    page: Optional[int] = Field(1, ge=1, description="The page number to return, first page is 1")


class ReviewsRequest(BaseModel):
    fid: str = Field(..., description="The FID")
    cid: Optional[str] = Field(None, description="The CID to search in")
    placeId: Optional[str] = Field(None, description="The place ID to search in")
    sortBy: Optional[ReviewSortBy] = Field(ReviewSortBy.mostRelevant, description="The sort order to use")
    topicId: Optional[str] = Field(None, description="The topic ID to search in")
    nextPageToken: Optional[str] = Field(None, description="The next page token to use")
    gl: Optional[str] = Field(None, description="The country to search in, e.g. us, uk, ca, au, etc.")
    hl: Optional[str] = Field(None, description="The language to search in, e.g. en, es, fr, de, etc.")


class ShoppingRequest(BaseRequest):
    autocorrect: Optional[bool] = Field(True, description="Automatically correct")
    num: int = Field(10, le=100, description="The number of results to return, max is 100")


class LensRequest(BaseModel):
    url: str = Field(..., description="The url to search")
    gl: Optional[str] = Field(None, description="The country to search in, e.g. us, uk, ca, au, etc.")
    hl: Optional[str] = Field(None, description="The language to search in, e.g. en, es, fr, de, etc.")


class ParentsRequest(BaseModel):
    q: str = Field(..., description="The query to search for")
    num: int = Field(10, le=100, description="The number of results to return, max is 100")
    page: Optional[int] = Field(1, ge=1, description="The page number to return, first page is 1")


class WebpageRequest(BaseModel):
    url: str
    includeMarkdown: Optional[bool] = False