feat(api): update via SDK Studio

Author: stainless-app[bot]

CONTRIBUTING.md

@@ -36,7 +36,7 @@ $ pip install -r requirements-dev.lock
 
 Most of the SDK is generated code. Modifications to code will be persisted between generations, but may
 result in merge conflicts between manual patches and changes from the generator. The generator will never
-modify the contents of the `src/browser_use/lib/` and `examples/` directories.
+modify the contents of the `src/browser_use_sdk/lib/` and `examples/` directories.
 
 ## Adding and running examples
 

README.md

@@ -26,7 +26,7 @@ The full API of this library can be found in [api.md](api.md).
 
 ```python
 import os
-from browser_use import BrowserUse
+from browser_use_sdk import BrowserUse
 
 client = BrowserUse(
     api_key=os.environ.get("BROWSER_USE_API_KEY"),  # This is the default and can be omitted
@@ -48,7 +48,7 @@ Simply import `AsyncBrowserUse` instead of `BrowserUse` and use `await` with eac
 ```python
 import os
 import asyncio
-from browser_use import AsyncBrowserUse
+from browser_use_sdk import AsyncBrowserUse
 
 client = AsyncBrowserUse(
     api_key=os.environ.get("BROWSER_USE_API_KEY"),  # This is the default and can be omitted
@@ -80,8 +80,8 @@ Then you can enable it by instantiating the client with `http_client=DefaultAioH
 
 ```python
 import asyncio
-from browser_use import DefaultAioHttpClient
-from browser_use import AsyncBrowserUse
+from browser_use_sdk import DefaultAioHttpClient
+from browser_use_sdk import AsyncBrowserUse
 
 
 async def main() -> None:
@@ -110,7 +110,7 @@ Typed requests and responses provide autocomplete and documentation within your
 Nested parameters are dictionaries, typed using `TypedDict`, for example:
 
 ```python
-from browser_use import BrowserUse
+from browser_use_sdk import BrowserUse
 
 client = BrowserUse()
 
@@ -123,27 +123,27 @@ print(task_view.agent_settings)
 
 ## Handling errors
 
-When the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of `browser_use.APIConnectionError` is raised.
+When the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of `browser_use_sdk.APIConnectionError` is raised.
 
 When the API returns a non-success status code (that is, 4xx or 5xx
-response), a subclass of `browser_use.APIStatusError` is raised, containing `status_code` and `response` properties.
+response), a subclass of `browser_use_sdk.APIStatusError` is raised, containing `status_code` and `response` properties.
 
-All errors inherit from `browser_use.APIError`.
+All errors inherit from `browser_use_sdk.APIError`.
 
 ```python
-import browser_use
-from browser_use import BrowserUse
+import browser_use_sdk
+from browser_use_sdk import BrowserUse
 
 client = BrowserUse()
 
 try:
     client.tasks.list()
-except browser_use.APIConnectionError as e:
+except browser_use_sdk.APIConnectionError as e:
     print("The server could not be reached")
     print(e.__cause__)  # an underlying Exception, likely raised within httpx.
-except browser_use.RateLimitError as e:
+except browser_use_sdk.RateLimitError as e:
     print("A 429 status code was received; we should back off a bit.")
-except browser_use.APIStatusError as e:
+except browser_use_sdk.APIStatusError as e:
     print("Another non-200-range status code was received")
     print(e.status_code)
     print(e.response)
@@ -171,7 +171,7 @@ Connection errors (for example, due to a network connectivity problem), 408 Requ
 You can use the `max_retries` option to configure or disable retry settings:
 
 ```python
-from browser_use import BrowserUse
+from browser_use_sdk import BrowserUse
 
 # Configure the default for all requests:
 client = BrowserUse(
@@ -189,7 +189,7 @@ By default requests time out after 1 minute. You can configure this with a `time
 which accepts a float or an [`httpx.Timeout`](https://www.python-httpx.org/advanced/timeouts/#fine-tuning-the-configuration) object:
 
 ```python
-from browser_use import BrowserUse
+from browser_use_sdk import BrowserUse
 
 # Configure the default for all requests:
 client = BrowserUse(
@@ -241,7 +241,7 @@ if response.my_field is None:
 The "raw" Response object can be accessed by prefixing `.with_raw_response.` to any HTTP method call, e.g.,
 
 ```py
-from browser_use import BrowserUse
+from browser_use_sdk import BrowserUse
 
 client = BrowserUse()
 response = client.tasks.with_raw_response.list()
@@ -251,9 +251,9 @@ task = response.parse()  # get the object that `tasks.list()` would have returne
 print(task.items)
 ```
 
-These methods return an [`APIResponse`](https://github.com/browser-use/browser-use-python/tree/main/src/browser_use/_response.py) object.
+These methods return an [`APIResponse`](https://github.com/browser-use/browser-use-python/tree/main/src/browser_use_sdk/_response.py) object.
 
-The async client returns an [`AsyncAPIResponse`](https://github.com/browser-use/browser-use-python/tree/main/src/browser_use/_response.py) with the same structure, the only difference being `await`able methods for reading the response content.
+The async client returns an [`AsyncAPIResponse`](https://github.com/browser-use/browser-use-python/tree/main/src/browser_use_sdk/_response.py) with the same structure, the only difference being `await`able methods for reading the response content.
 
 #### `.with_streaming_response`
 
@@ -315,7 +315,7 @@ You can directly override the [httpx client](https://www.python-httpx.org/api/#c
 
 ```python
 import httpx
-from browser_use import BrowserUse, DefaultHttpxClient
+from browser_use_sdk import BrowserUse, DefaultHttpxClient
 
 client = BrowserUse(
     # Or use the `BROWSER_USE_BASE_URL` env var
@@ -338,7 +338,7 @@ client.with_options(http_client=DefaultHttpxClient(...))
 By default the library closes underlying HTTP connections whenever the client is [garbage collected](https://docs.python.org/3/reference/datamodel.html#object.__del__). You can manually close the client using the `.close()` method if desired, or with a context manager that closes when exiting.
 
 ```py
-from browser_use import BrowserUse
+from browser_use_sdk import BrowserUse
 
 with BrowserUse() as client:
   # make requests here
@@ -366,8 +366,8 @@ If you've upgraded to the latest version but aren't seeing any new features you
 You can determine the version that is being used at runtime with:
 
 ```py
-import browser_use
-print(browser_use.__version__)
+import browser_use_sdk
+print(browser_use_sdk.__version__)
 ```
 
 ## Requirements

api.md

@@ -3,7 +3,7 @@
 Types:
 
 ```python
-from browser_use.types import (
+from browser_use_sdk.types import (
     LlmModel,
     TaskStatus,
     TaskView,
@@ -16,69 +16,69 @@ from browser_use.types import (
 
 Methods:
 
-- <code title="post /tasks">client.tasks.<a href="./src/browser_use/resources/tasks.py">create</a>(\*\*<a href="src/browser_use/types/task_create_params.py">params</a>) -> <a href="./src/browser_use/types/task_view.py">TaskView</a></code>
-- <code title="get /tasks/{task_id}">client.tasks.<a href="./src/browser_use/resources/tasks.py">retrieve</a>(task_id, \*\*<a href="src/browser_use/types/task_retrieve_params.py">params</a>) -> <a href="./src/browser_use/types/task_retrieve_response.py">TaskRetrieveResponse</a></code>
-- <code title="patch /tasks/{task_id}">client.tasks.<a href="./src/browser_use/resources/tasks.py">update</a>(task_id, \*\*<a href="src/browser_use/types/task_update_params.py">params</a>) -> <a href="./src/browser_use/types/task_view.py">TaskView</a></code>
-- <code title="get /tasks">client.tasks.<a href="./src/browser_use/resources/tasks.py">list</a>(\*\*<a href="src/browser_use/types/task_list_params.py">params</a>) -> <a href="./src/browser_use/types/task_list_response.py">TaskListResponse</a></code>
-- <code title="get /tasks/{task_id}/logs">client.tasks.<a href="./src/browser_use/resources/tasks.py">retrieve_logs</a>(task_id) -> <a href="./src/browser_use/types/task_retrieve_logs_response.py">TaskRetrieveLogsResponse</a></code>
-- <code title="get /tasks/{task_id}/output-files/{file_name}">client.tasks.<a href="./src/browser_use/resources/tasks.py">retrieve_output_file</a>(file_name, \*, task_id) -> <a href="./src/browser_use/types/task_retrieve_output_file_response.py">TaskRetrieveOutputFileResponse</a></code>
+- <code title="post /tasks">client.tasks.<a href="./src/browser_use_sdk/resources/tasks.py">create</a>(\*\*<a href="src/browser_use_sdk/types/task_create_params.py">params</a>) -> <a href="./src/browser_use_sdk/types/task_view.py">TaskView</a></code>
+- <code title="get /tasks/{task_id}">client.tasks.<a href="./src/browser_use_sdk/resources/tasks.py">retrieve</a>(task_id, \*\*<a href="src/browser_use_sdk/types/task_retrieve_params.py">params</a>) -> <a href="./src/browser_use_sdk/types/task_retrieve_response.py">TaskRetrieveResponse</a></code>
+- <code title="patch /tasks/{task_id}">client.tasks.<a href="./src/browser_use_sdk/resources/tasks.py">update</a>(task_id, \*\*<a href="src/browser_use_sdk/types/task_update_params.py">params</a>) -> <a href="./src/browser_use_sdk/types/task_view.py">TaskView</a></code>
+- <code title="get /tasks">client.tasks.<a href="./src/browser_use_sdk/resources/tasks.py">list</a>(\*\*<a href="src/browser_use_sdk/types/task_list_params.py">params</a>) -> <a href="./src/browser_use_sdk/types/task_list_response.py">TaskListResponse</a></code>
+- <code title="get /tasks/{task_id}/logs">client.tasks.<a href="./src/browser_use_sdk/resources/tasks.py">retrieve_logs</a>(task_id) -> <a href="./src/browser_use_sdk/types/task_retrieve_logs_response.py">TaskRetrieveLogsResponse</a></code>
+- <code title="get /tasks/{task_id}/output-files/{file_name}">client.tasks.<a href="./src/browser_use_sdk/resources/tasks.py">retrieve_output_file</a>(file_name, \*, task_id) -> <a href="./src/browser_use_sdk/types/task_retrieve_output_file_response.py">TaskRetrieveOutputFileResponse</a></code>
 
 # Sessions
 
 Types:
 
 ```python
-from browser_use.types import SessionStatus, SessionView, SessionListResponse
+from browser_use_sdk.types import SessionStatus, SessionView, SessionListResponse
 ```
 
 Methods:
 
-- <code title="get /sessions/{session_id}">client.sessions.<a href="./src/browser_use/resources/sessions/sessions.py">retrieve</a>(session_id, \*\*<a href="src/browser_use/types/session_retrieve_params.py">params</a>) -> <a href="./src/browser_use/types/session_view.py">SessionView</a></code>
-- <code title="patch /sessions/{session_id}">client.sessions.<a href="./src/browser_use/resources/sessions/sessions.py">update</a>(session_id, \*\*<a href="src/browser_use/types/session_update_params.py">params</a>) -> <a href="./src/browser_use/types/session_view.py">SessionView</a></code>
-- <code title="get /sessions">client.sessions.<a href="./src/browser_use/resources/sessions/sessions.py">list</a>(\*\*<a href="src/browser_use/types/session_list_params.py">params</a>) -> <a href="./src/browser_use/types/session_list_response.py">SessionListResponse</a></code>
+- <code title="get /sessions/{session_id}">client.sessions.<a href="./src/browser_use_sdk/resources/sessions/sessions.py">retrieve</a>(session_id, \*\*<a href="src/browser_use_sdk/types/session_retrieve_params.py">params</a>) -> <a href="./src/browser_use_sdk/types/session_view.py">SessionView</a></code>
+- <code title="patch /sessions/{session_id}">client.sessions.<a href="./src/browser_use_sdk/resources/sessions/sessions.py">update</a>(session_id, \*\*<a href="src/browser_use_sdk/types/session_update_params.py">params</a>) -> <a href="./src/browser_use_sdk/types/session_view.py">SessionView</a></code>
+- <code title="get /sessions">client.sessions.<a href="./src/browser_use_sdk/resources/sessions/sessions.py">list</a>(\*\*<a href="src/browser_use_sdk/types/session_list_params.py">params</a>) -> <a href="./src/browser_use_sdk/types/session_list_response.py">SessionListResponse</a></code>
 
 ## PublicShare
 
 Types:
 
 ```python
-from browser_use.types.sessions import ShareView
+from browser_use_sdk.types.sessions import ShareView
 ```
 
 Methods:
 
-- <code title="post /sessions/{session_id}/public-share">client.sessions.public_share.<a href="./src/browser_use/resources/sessions/public_share.py">create</a>(session_id) -> <a href="./src/browser_use/types/sessions/share_view.py">ShareView</a></code>
-- <code title="get /sessions/{session_id}/public-share">client.sessions.public_share.<a href="./src/browser_use/resources/sessions/public_share.py">retrieve</a>(session_id) -> <a href="./src/browser_use/types/sessions/share_view.py">ShareView</a></code>
-- <code title="delete /sessions/{session_id}/public-share">client.sessions.public_share.<a href="./src/browser_use/resources/sessions/public_share.py">delete</a>(session_id) -> object</code>
+- <code title="post /sessions/{session_id}/public-share">client.sessions.public_share.<a href="./src/browser_use_sdk/resources/sessions/public_share.py">create</a>(session_id) -> <a href="./src/browser_use_sdk/types/sessions/share_view.py">ShareView</a></code>
+- <code title="get /sessions/{session_id}/public-share">client.sessions.public_share.<a href="./src/browser_use_sdk/resources/sessions/public_share.py">retrieve</a>(session_id) -> <a href="./src/browser_use_sdk/types/sessions/share_view.py">ShareView</a></code>
+- <code title="delete /sessions/{session_id}/public-share">client.sessions.public_share.<a href="./src/browser_use_sdk/resources/sessions/public_share.py">delete</a>(session_id) -> object</code>
 
 # BrowserProfiles
 
 Types:
 
 ```python
-from browser_use.types import BrowserProfileView, ProxyCountryCode, BrowserProfileListResponse
+from browser_use_sdk.types import BrowserProfileView, ProxyCountryCode, BrowserProfileListResponse
 ```
 
 Methods:
 
-- <code title="post /browser-profiles">client.browser_profiles.<a href="./src/browser_use/resources/browser_profiles.py">create</a>(\*\*<a href="src/browser_use/types/browser_profile_create_params.py">params</a>) -> <a href="./src/browser_use/types/browser_profile_view.py">BrowserProfileView</a></code>
-- <code title="get /browser-profiles/{profile_id}">client.browser_profiles.<a href="./src/browser_use/resources/browser_profiles.py">retrieve</a>(profile_id) -> <a href="./src/browser_use/types/browser_profile_view.py">BrowserProfileView</a></code>
-- <code title="patch /browser-profiles/{profile_id}">client.browser_profiles.<a href="./src/browser_use/resources/browser_profiles.py">update</a>(profile_id, \*\*<a href="src/browser_use/types/browser_profile_update_params.py">params</a>) -> <a href="./src/browser_use/types/browser_profile_view.py">BrowserProfileView</a></code>
-- <code title="get /browser-profiles">client.browser_profiles.<a href="./src/browser_use/resources/browser_profiles.py">list</a>(\*\*<a href="src/browser_use/types/browser_profile_list_params.py">params</a>) -> <a href="./src/browser_use/types/browser_profile_list_response.py">BrowserProfileListResponse</a></code>
-- <code title="delete /browser-profiles/{profile_id}">client.browser_profiles.<a href="./src/browser_use/resources/browser_profiles.py">delete</a>(profile_id) -> object</code>
+- <code title="post /browser-profiles">client.browser_profiles.<a href="./src/browser_use_sdk/resources/browser_profiles.py">create</a>(\*\*<a href="src/browser_use_sdk/types/browser_profile_create_params.py">params</a>) -> <a href="./src/browser_use_sdk/types/browser_profile_view.py">BrowserProfileView</a></code>
+- <code title="get /browser-profiles/{profile_id}">client.browser_profiles.<a href="./src/browser_use_sdk/resources/browser_profiles.py">retrieve</a>(profile_id) -> <a href="./src/browser_use_sdk/types/browser_profile_view.py">BrowserProfileView</a></code>
+- <code title="patch /browser-profiles/{profile_id}">client.browser_profiles.<a href="./src/browser_use_sdk/resources/browser_profiles.py">update</a>(profile_id, \*\*<a href="src/browser_use_sdk/types/browser_profile_update_params.py">params</a>) -> <a href="./src/browser_use_sdk/types/browser_profile_view.py">BrowserProfileView</a></code>
+- <code title="get /browser-profiles">client.browser_profiles.<a href="./src/browser_use_sdk/resources/browser_profiles.py">list</a>(\*\*<a href="src/browser_use_sdk/types/browser_profile_list_params.py">params</a>) -> <a href="./src/browser_use_sdk/types/browser_profile_list_response.py">BrowserProfileListResponse</a></code>
+- <code title="delete /browser-profiles/{profile_id}">client.browser_profiles.<a href="./src/browser_use_sdk/resources/browser_profiles.py">delete</a>(profile_id) -> object</code>
 
 # AgentProfiles
 
 Types:
 
 ```python
-from browser_use.types import AgentProfileView, AgentProfileListResponse
+from browser_use_sdk.types import AgentProfileView, AgentProfileListResponse
 ```
 
 Methods:
 
-- <code title="post /agent-profiles">client.agent_profiles.<a href="./src/browser_use/resources/agent_profiles.py">create</a>(\*\*<a href="src/browser_use/types/agent_profile_create_params.py">params</a>) -> <a href="./src/browser_use/types/agent_profile_view.py">AgentProfileView</a></code>
-- <code title="get /agent-profiles/{profile_id}">client.agent_profiles.<a href="./src/browser_use/resources/agent_profiles.py">retrieve</a>(profile_id) -> <a href="./src/browser_use/types/agent_profile_view.py">AgentProfileView</a></code>
-- <code title="patch /agent-profiles/{profile_id}">client.agent_profiles.<a href="./src/browser_use/resources/agent_profiles.py">update</a>(profile_id, \*\*<a href="src/browser_use/types/agent_profile_update_params.py">params</a>) -> <a href="./src/browser_use/types/agent_profile_view.py">AgentProfileView</a></code>
-- <code title="get /agent-profiles">client.agent_profiles.<a href="./src/browser_use/resources/agent_profiles.py">list</a>(\*\*<a href="src/browser_use/types/agent_profile_list_params.py">params</a>) -> <a href="./src/browser_use/types/agent_profile_list_response.py">AgentProfileListResponse</a></code>
-- <code title="delete /agent-profiles/{profile_id}">client.agent_profiles.<a href="./src/browser_use/resources/agent_profiles.py">delete</a>(profile_id) -> object</code>
+- <code title="post /agent-profiles">client.agent_profiles.<a href="./src/browser_use_sdk/resources/agent_profiles.py">create</a>(\*\*<a href="src/browser_use_sdk/types/agent_profile_create_params.py">params</a>) -> <a href="./src/browser_use_sdk/types/agent_profile_view.py">AgentProfileView</a></code>
+- <code title="get /agent-profiles/{profile_id}">client.agent_profiles.<a href="./src/browser_use_sdk/resources/agent_profiles.py">retrieve</a>(profile_id) -> <a href="./src/browser_use_sdk/types/agent_profile_view.py">AgentProfileView</a></code>
+- <code title="patch /agent-profiles/{profile_id}">client.agent_profiles.<a href="./src/browser_use_sdk/resources/agent_profiles.py">update</a>(profile_id, \*\*<a href="src/browser_use_sdk/types/agent_profile_update_params.py">params</a>) -> <a href="./src/browser_use_sdk/types/agent_profile_view.py">AgentProfileView</a></code>
+- <code title="get /agent-profiles">client.agent_profiles.<a href="./src/browser_use_sdk/resources/agent_profiles.py">list</a>(\*\*<a href="src/browser_use_sdk/types/agent_profile_list_params.py">params</a>) -> <a href="./src/browser_use_sdk/types/agent_profile_list_response.py">AgentProfileListResponse</a></code>
+- <code title="delete /agent-profiles/{profile_id}">client.agent_profiles.<a href="./src/browser_use_sdk/resources/agent_profiles.py">delete</a>(profile_id) -> object</code>

mypy.ini

@@ -8,7 +8,7 @@ show_error_codes = True
 #
 # We also exclude our `tests` as mypy doesn't always infer
 # types correctly and Pyright will still catch any type errors.
-exclude = ^(src/browser_use/_files\.py|_dev/.*\.py|tests/.*)$
+exclude = ^(src/browser_use_sdk/_files\.py|_dev/.*\.py|tests/.*)$
 
 strict_equality = True
 implicit_reexport = True