anchorbrowser 0.1.0a3__py3-none-any.whl → 0.1.1__py3-none-any.whl

anchorbrowser/types/session_create_params.py

@@ -5,11 +5,15 @@ from __future__ import annotations
 from typing import Union
 from typing_extensions import Literal, Required, TypeAlias, TypedDict
 
+from .._types import SequenceNotStr
+
 __all__ = [
     "SessionCreateParams",
     "Browser",
     "BrowserAdblock",
     "BrowserCaptchaSolver",
+    "BrowserDisableWebSecurity",
+    "BrowserFullscreen",
     "BrowserHeadless",
     "BrowserP2pDownload",
     "BrowserPopupBlocker",
@@ -18,9 +22,8 @@ __all__ = [
     "Session",
     "SessionLiveView",
     "SessionProxy",
-    "SessionProxyAnchorResidentialProxyType",
-    "SessionProxyAnchorMobileProxyType",
-    "SessionProxyCustomProxyType",
+    "SessionProxyAnchorProxy",
+    "SessionProxyCustomProxy",
     "SessionRecording",
     "SessionTimeout",
 ]
@@ -47,6 +50,23 @@ class BrowserCaptchaSolver(TypedDict, total=False):
     """
 
 
+class BrowserDisableWebSecurity(TypedDict, total=False):
+    active: bool
+    """Whether to disable web security features (CORS, same-origin policy, etc.).
+
+    Allows accessing iframes and resources from different origins. Defaults to
+    `false`.
+    """
+
+
+class BrowserFullscreen(TypedDict, total=False):
+    active: bool
+    """Enable or disable fullscreen mode.
+
+    When enabled, the browser will start in fullscreen mode. Defaults to `false`.
+    """
+
+
 class BrowserHeadless(TypedDict, total=False):
     active: bool
     """Whether browser should be headless or headful. Defaults to `false`."""
@@ -79,10 +99,10 @@ class BrowserProfile(TypedDict, total=False):
     browser session ends. Defaults to `false`.
     """
 
-    store_cache: bool
-    """
-    Indicates whether the browser session cache should be saved when the browser
-    session ends. Defaults to `false`.
+    reset_preferences: bool
+    """When enabled, resets the profile's preferences on session creation.
+
+    Defaults to `false`.
     """
 
 
@@ -101,6 +121,18 @@ class Browser(TypedDict, total=False):
     captcha_solver: BrowserCaptchaSolver
     """Configuration for captcha-solving."""
 
+    disable_web_security: BrowserDisableWebSecurity
+    """Configuration for disabling web security features."""
+
+    extensions: SequenceNotStr[str]
+    """Array of extension IDs to load in the browser session.
+
+    Extensions must be previously uploaded using the Extensions API.
+    """
+
+    fullscreen: BrowserFullscreen
+    """Configuration for fullscreen mode."""
+
     headless: BrowserHeadless
     """Configuration for headless mode."""
 
@@ -122,27 +154,230 @@ class SessionLiveView(TypedDict, total=False):
     """Enable or disable read-only mode for live viewing. Defaults to `false`."""
 
 
-class SessionProxyAnchorResidentialProxyType(TypedDict, total=False):
-    type: Required[Literal["anchor_residential"]]
+class SessionProxyAnchorProxy(TypedDict, total=False):
+    active: Required[bool]
 
-    active: bool
     """Enable or disable proxy usage. Defaults to `false`."""
+    city: str
+    """City name for precise geographic targeting.
 
-    country_code: Literal["us", "uk", "fr", "it", "jp", "au", "de", "fi", "ca"]
-    """Country code for residential proxy"""
+    Supported for anchor_proxy only. Can only be used when region is also provided.
+    Example: "San Francisco", "los-angeles", "london"
+    """
 
+    country_code: Literal[
+        "af",
+        "al",
+        "dz",
+        "ad",
+        "ao",
+        "as",
+        "ag",
+        "ar",
+        "am",
+        "aw",
+        "au",
+        "at",
+        "az",
+        "bs",
+        "bh",
+        "bb",
+        "by",
+        "be",
+        "bz",
+        "bj",
+        "bm",
+        "bo",
+        "ba",
+        "br",
+        "bg",
+        "bf",
+        "cm",
+        "ca",
+        "cv",
+        "td",
+        "cl",
+        "co",
+        "cg",
+        "cr",
+        "ci",
+        "hr",
+        "cu",
+        "cy",
+        "cz",
+        "dk",
+        "dm",
+        "do",
+        "ec",
+        "eg",
+        "sv",
+        "ee",
+        "et",
+        "fo",
+        "fi",
+        "fr",
+        "gf",
+        "pf",
+        "ga",
+        "gm",
+        "ge",
+        "de",
+        "gh",
+        "gi",
+        "gr",
+        "gd",
+        "gp",
+        "gt",
+        "gg",
+        "gn",
+        "gw",
+        "gy",
+        "ht",
+        "hn",
+        "hu",
+        "is",
+        "in",
+        "ir",
+        "iq",
+        "ie",
+        "il",
+        "it",
+        "jm",
+        "jp",
+        "jo",
+        "kz",
+        "kw",
+        "kg",
+        "lv",
+        "lb",
+        "ly",
+        "li",
+        "lt",
+        "lu",
+        "mk",
+        "ml",
+        "mt",
+        "mq",
+        "mr",
+        "mx",
+        "md",
+        "mc",
+        "me",
+        "ma",
+        "nl",
+        "nz",
+        "ni",
+        "ng",
+        "no",
+        "pk",
+        "pa",
+        "py",
+        "pe",
+        "ph",
+        "pl",
+        "pt",
+        "pr",
+        "qa",
+        "ro",
+        "lc",
+        "sm",
+        "sa",
+        "sn",
+        "rs",
+        "sc",
+        "sl",
+        "sk",
+        "si",
+        "so",
+        "za",
+        "kr",
+        "es",
+        "sr",
+        "se",
+        "ch",
+        "sy",
+        "st",
+        "tw",
+        "tj",
+        "tg",
+        "tt",
+        "tn",
+        "tr",
+        "tc",
+        "ua",
+        "ae",
+        "us",
+        "uy",
+        "uz",
+        "ve",
+        "ye",
+        "bd",
+        "bw",
+        "bn",
+        "bi",
+        "kh",
+        "cn",
+        "dj",
+        "gq",
+        "sz",
+        "fj",
+        "hk",
+        "id",
+        "ke",
+        "la",
+        "ls",
+        "lr",
+        "mg",
+        "mw",
+        "my",
+        "mv",
+        "mn",
+        "mz",
+        "mm",
+        "na",
+        "np",
+        "nc",
+        "ne",
+        "om",
+        "pg",
+        "ru",
+        "rw",
+        "ws",
+        "sg",
+        "ss",
+        "lk",
+        "sd",
+        "tz",
+        "th",
+        "tl",
+        "tm",
+        "ug",
+        "gb",
+        "vu",
+        "vn",
+        "zm",
+        "zw",
+        "bt",
+        "mu",
+    ]
+    """Supported country codes ISO 2 lowercase
+
+    **On change make sure to update the Proxy type.**
+    """
 
-class SessionProxyAnchorMobileProxyType(TypedDict, total=False):
-    type: Required[Literal["anchor_mobile"]]
+    region: str
+    """
+    Region code for more specific geographic targeting. The city parameter can only
+    be used when region is also provided. Example: "ca" for California
+    """
 
-    active: bool
-    """Enable or disable proxy usage. Defaults to `false`."""
+    type: Literal["anchor_proxy", "anchor_residential", "anchor_mobile", "anchor_gov"]
+    """**On change make sure to update the country_code.**"""
 
-    country_code: Literal["us", "uk", "fr", "it", "jp", "au", "de", "fi", "ca"]
-    """Country code for mobile proxy"""
 
+class SessionProxyCustomProxy(TypedDict, total=False):
+    active: Required[bool]
 
-class SessionProxyCustomProxyType(TypedDict, total=False):
     password: Required[str]
     """Proxy password"""
 
@@ -154,13 +389,8 @@ class SessionProxyCustomProxyType(TypedDict, total=False):
     username: Required[str]
     """Proxy username"""
 
-    active: bool
-    """Enable or disable proxy usage. Defaults to `false`."""
-
 
-SessionProxy: TypeAlias = Union[
-    SessionProxyAnchorResidentialProxyType, SessionProxyAnchorMobileProxyType, SessionProxyCustomProxyType
-]
+SessionProxy: TypeAlias = Union[SessionProxyAnchorProxy, SessionProxyCustomProxy]
 
 
 class SessionRecording(TypedDict, total=False):
@@ -183,11 +413,17 @@ class SessionTimeout(TypedDict, total=False):
 
 
 class Session(TypedDict, total=False):
+    initial_url: str
+    """The URL to navigate to when the browser session starts.
+
+    If not provided, the browser will load an empty page.
+    """
+
     live_view: SessionLiveView
     """Configuration for live viewing the browser session."""
 
     proxy: SessionProxy
-    """Configuration options for proxy usage."""
+    """Proxy Documentation available at [Proxy Documentation](/advanced/proxy)"""
 
     recording: SessionRecording
     """Configuration for session recording."""

anchorbrowser/types/session_list_pages_response.py

@@ -0,0 +1,25 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+from typing_extensions import TypeAlias
+
+from .._models import BaseModel
+
+__all__ = ["SessionListPagesResponse", "SessionListPagesResponseItem"]
+
+
+class SessionListPagesResponseItem(BaseModel):
+    id: str
+    """The unique identifier of the page."""
+
+    frontend_url: str
+    """The frontend URL for accessing the page."""
+
+    title: str
+    """The title of the page."""
+
+    url: str
+    """The URL of the page."""
+
+
+SessionListPagesResponse: TypeAlias = List[SessionListPagesResponseItem]

anchorbrowser/types/session_retrieve_response.py

@@ -0,0 +1,46 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from datetime import datetime
+
+from .._models import BaseModel
+
+__all__ = ["SessionRetrieveResponse"]
+
+
+class SessionRetrieveResponse(BaseModel):
+    configuration: Optional[object] = None
+    """The configuration settings for the session."""
+
+    created_at: Optional[datetime] = None
+    """The timestamp when the session was created."""
+
+    credits_used: Optional[float] = None
+    """The number of credits consumed by the session."""
+
+    duration: Optional[int] = None
+    """The duration of the session in seconds."""
+
+    playground: Optional[bool] = None
+    """Whether this is a playground session."""
+
+    proxy_bytes: Optional[int] = None
+    """The number of bytes transferred through the proxy."""
+
+    session_id: Optional[str] = None
+    """The unique identifier of the session."""
+
+    status: Optional[str] = None
+    """The current status of the session."""
+
+    steps: Optional[List[object]] = None
+    """Array of steps executed in the session."""
+
+    tags: Optional[object] = None
+    """Tags associated with the session."""
+
+    team_id: Optional[str] = None
+    """The team ID associated with the session."""
+
+    tokens: Optional[object] = None
+    """Token usage information."""

anchorbrowser/types/session_scroll_params.py

@@ -24,3 +24,6 @@ class SessionScrollParams(TypedDict, total=False):
 
     steps: int
     """Number of steps to break the scroll into for smoother scrolling"""
+
+    use_os: Annotated[bool, PropertyInfo(alias="useOs")]
+    """Whether to use the OS scroll or the Playwright scroll"""

anchorbrowser/types/session_upload_file_params.py

@@ -0,0 +1,14 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+from .._types import FileTypes
+
+__all__ = ["SessionUploadFileParams"]
+
+
+class SessionUploadFileParams(TypedDict, total=False):
+    file: Required[FileTypes]
+    """File to upload to the browser session"""

anchorbrowser/types/session_upload_file_response.py

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from .._models import BaseModel
+
+__all__ = ["SessionUploadFileResponse", "Data"]
+
+
+class Data(BaseModel):
+    message: Optional[str] = None
+
+    status: Optional[str] = None
+
+
+class SessionUploadFileResponse(BaseModel):
+    data: Optional[Data] = None

anchorbrowser/types/sessions/keyboard_shortcut_params.py

@@ -2,16 +2,16 @@
 
 from __future__ import annotations
 
-from typing import List
 from typing_extensions import Required, Annotated, TypedDict
 
+from ..._types import SequenceNotStr
 from ..._utils import PropertyInfo
 
 __all__ = ["KeyboardShortcutParams"]
 
 
 class KeyboardShortcutParams(TypedDict, total=False):
-    keys: Required[List[str]]
+    keys: Required[SequenceNotStr[str]]
     """Array of keys to press simultaneously"""
 
     hold_time: Annotated[int, PropertyInfo(alias="holdTime")]

anchorbrowser/types/sessions/recording_list_response.py

@@ -5,10 +5,10 @@ from datetime import datetime
 
 from ..._models import BaseModel
 
-__all__ = ["RecordingListResponse", "Data", "DataData", "DataDataItem"]
+__all__ = ["RecordingListResponse", "Data", "DataItem"]
 
 
-class DataDataItem(BaseModel):
+class DataItem(BaseModel):
     id: Optional[str] = None
     """Unique identifier for the recording"""
 
@@ -31,15 +31,11 @@ class DataDataItem(BaseModel):
     """Suggested filename for the recording"""
 
 
-class DataData(BaseModel):
+class Data(BaseModel):
     count: Optional[int] = None
     """Total number of video recordings"""
 
-    items: Optional[List[DataDataItem]] = None
-
-
-class Data(BaseModel):
-    data: Optional[DataData] = None
+    items: Optional[List[DataItem]] = None
 
 
 class RecordingListResponse(BaseModel):

anchorbrowser/types/tool_fetch_webpage_params.py

@@ -19,8 +19,23 @@ class ToolFetchWebpageParams(TypedDict, total=False):
     format: Literal["html", "markdown"]
     """The output format of the content."""
 
+    new_page: bool
+    """Whether to create a new page for the content."""
+
+    page_index: int
+    """The index of the page to fetch content from. **Overides new_page**."""
+
+    return_partial_on_timeout: bool
+    """
+    Whether to return partial content if the content is not loaded within the 20
+    seconds.
+    """
+
     url: str
     """The URL of the webpage to fetch content from.
 
     When left empty, the current webpage is used.
     """
+
+    wait: int
+    """The time to wait for **dynamic** content to load in **milliseconds**."""

anchorbrowser/types/tool_perform_web_task_params.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing_extensions import Required, Annotated, TypedDict
+from typing_extensions import Literal, Required, Annotated, TypedDict
 
 from .._utils import PropertyInfo
 
@@ -20,9 +20,25 @@ class ToolPerformWebTaskParams(TypedDict, total=False):
     session.
     """
 
+    agent: Literal["browser-use", "openai-cua"]
+    """The AI agent to use for task completion. Defaults to browser-use."""
+
+    highlight_elements: bool
+    """Whether to highlight elements during task execution for better visibility."""
+
+    model: str
+    """The specific model to use for task completion.
+
+    see our [models](/agentic-browser-control/ai-task-completion#available-models)
+    page for more information.
+    """
+
     output_schema: object
     """JSON Schema defining the expected structure of the output data."""
 
+    provider: Literal["openai", "gemini", "groq", "azure", "xai"]
+    """The AI provider to use for task completion."""
+
     url: str
     """The URL of the webpage.
 

anchorbrowser/types/tool_perform_web_task_response.py

@@ -1,6 +1,6 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-from typing import Dict, Union, Optional
+from typing import Optional
 
 from .._models import BaseModel
 
@@ -8,8 +8,8 @@ __all__ = ["ToolPerformWebTaskResponse", "Data"]
 
 
 class Data(BaseModel):
-    result: Union[str, Dict[str, object], None] = None
-    """The outcome or answer as a string"""
+    result: Optional[str] = None
+    """The outcome or answer produced by the autonomous task."""
 
 
 class ToolPerformWebTaskResponse(BaseModel):

{anchorbrowser-0.1.0a3.dist-info → anchorbrowser-0.1.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: anchorbrowser
-Version: 0.1.0a3
+Version: 0.1.1
 Summary: The official Python library for the anchorbrowser API
 Project-URL: Homepage, https://github.com/anchorbrowser/AnchorBrowser-SDK-Python
 Project-URL: Repository, https://github.com/anchorbrowser/AnchorBrowser-SDK-Python
@@ -25,11 +25,11 @@ Requires-Python: >=3.8
 Requires-Dist: anyio<5,>=3.5.0
 Requires-Dist: distro<2,>=1.7.0
 Requires-Dist: httpx<1,>=0.23.0
+Requires-Dist: playwright>=1.55.0
 Requires-Dist: pydantic<3,>=1.9.0
-Requires-Dist: pytest-playwright
 Requires-Dist: sniffio
 Requires-Dist: typing-extensions<5,>=4.10
-Requires-Dist: websockets
+Requires-Dist: websockets>=15.0.1
 Provides-Extra: aiohttp
 Requires-Dist: aiohttp; extra == 'aiohttp'
 Requires-Dist: httpx-aiohttp>=0.1.8; extra == 'aiohttp'
@@ -54,7 +54,7 @@ The REST API documentation can be found on [docs.anchorbrowser.io](https://docs.
 
 ```sh
 # install from PyPI
-pip install --pre anchorbrowser
+pip install anchorbrowser
 ```
 
 ## Usage
@@ -77,7 +77,7 @@ print(success_response.data)
 
 While you can provide an `api_key` keyword argument,
 we recommend using [python-dotenv](https://pypi.org/project/python-dotenv/)
-to add `ANCHORBROWSER_API_KEY="My API Key"` to your `.env` file
+to add `ANCHORBROWSER_API_KEY="Your API Key"` to your `.env` file
 so that your API Key is not stored in source control.
 
 ## Async usage
@@ -114,7 +114,7 @@ You can enable this by installing `aiohttp`:
 
 ```sh
 # install from PyPI
-pip install --pre anchorbrowser[aiohttp]
+pip install anchorbrowser[aiohttp]
 ```
 
 Then you can enable it by instantiating the client with `http_client=DefaultAioHttpClient()`:
@@ -127,7 +127,7 @@ from anchorbrowser import AsyncAnchorbrowser
 
 async def main() -> None:
     async with AsyncAnchorbrowser(
-        api_key="My API Key",
+        api_key="Your API Key",
         http_client=DefaultAioHttpClient(),
     ) as client:
         success_response = await client.profiles.create(
@@ -173,9 +173,8 @@ from anchorbrowser import Anchorbrowser
 
 client = Anchorbrowser()
 
-client.extensions.upload(
+client.sessions.upload_file(
     file=Path("/path/to/file"),
-    name="My Custom Extension",
 )
 ```