# This file was auto-generated by Fern from our API Definition. import typing from ..core.client_wrapper import SyncClientWrapper from ..core.request_options import RequestOptions from ..types.browser_session_response import BrowserSessionResponse from ..core.pydantic_utilities import parse_obj_as from ..errors.forbidden_error import ForbiddenError from ..errors.unprocessable_entity_error import UnprocessableEntityError from json.decoder import JSONDecodeError from ..core.api_error import ApiError from ..core.jsonable_encoder import jsonable_encoder from ..errors.not_found_error import NotFoundError from ..core.client_wrapper import AsyncClientWrapper # this is used as the default value for optional parameters OMIT = typing.cast(typing.Any, ...) class BrowserSessionClient: def __init__(self, *, client_wrapper: SyncClientWrapper): self._client_wrapper = client_wrapper def get_browser_sessions( self, *, request_options: typing.Optional[RequestOptions] = None ) -> typing.List[BrowserSessionResponse]: """ Get all active browser sessions for the organization Parameters ---------- request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- typing.List[BrowserSessionResponse] Successfully retrieved all active browser sessions Examples -------- from skyvern import Skyvern client = Skyvern( api_key="YOUR_API_KEY", authorization="YOUR_AUTHORIZATION", ) client.browser_session.get_browser_sessions() """ _response = self._client_wrapper.httpx_client.request( "v1/browser_sessions", method="GET", request_options=request_options, ) try: if 200 <= _response.status_code < 300: return typing.cast( typing.List[BrowserSessionResponse], parse_obj_as( type_=typing.List[BrowserSessionResponse], # type: ignore object_=_response.json(), ), ) if _response.status_code == 403: raise ForbiddenError( typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ) ) if _response.status_code == 422: raise UnprocessableEntityError( typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ) ) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, body=_response.text) raise ApiError(status_code=_response.status_code, body=_response_json) def create_browser_session( self, *, timeout: typing.Optional[int] = OMIT, request_options: typing.Optional[RequestOptions] = None ) -> BrowserSessionResponse: """ Create a new browser session Parameters ---------- timeout : typing.Optional[int] Timeout in minutes for the session. Timeout is applied after the session is started. Must be between 5 and 10080. Defaults to 60. request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- BrowserSessionResponse Successfully created browser session Examples -------- from skyvern import Skyvern client = Skyvern( api_key="YOUR_API_KEY", authorization="YOUR_AUTHORIZATION", ) client.browser_session.create_browser_session() """ _response = self._client_wrapper.httpx_client.request( "v1/browser_sessions", method="POST", json={ "timeout": timeout, }, headers={ "content-type": "application/json", }, request_options=request_options, omit=OMIT, ) try: if 200 <= _response.status_code < 300: return typing.cast( BrowserSessionResponse, parse_obj_as( type_=BrowserSessionResponse, # type: ignore object_=_response.json(), ), ) if _response.status_code == 403: raise ForbiddenError( typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ) ) if _response.status_code == 422: raise UnprocessableEntityError( typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ) ) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, body=_response.text) raise ApiError(status_code=_response.status_code, body=_response_json) def close_browser_session( self, browser_session_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> typing.Optional[typing.Any]: """ Close a browser session Parameters ---------- browser_session_id : str The ID of the browser session to close. completed_at will be set when the browser session is closed. browser_session_id starts with `pbs_` request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- typing.Optional[typing.Any] Successfully closed browser session Examples -------- from skyvern import Skyvern client = Skyvern( api_key="YOUR_API_KEY", authorization="YOUR_AUTHORIZATION", ) client.browser_session.close_browser_session( browser_session_id="pbs_123456", ) """ _response = self._client_wrapper.httpx_client.request( f"v1/browser_sessions/{jsonable_encoder(browser_session_id)}/close", method="POST", request_options=request_options, ) try: if 200 <= _response.status_code < 300: return typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ) if _response.status_code == 403: raise ForbiddenError( typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ) ) if _response.status_code == 422: raise UnprocessableEntityError( typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ) ) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, body=_response.text) raise ApiError(status_code=_response.status_code, body=_response_json) def get_browser_session( self, browser_session_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> BrowserSessionResponse: """ Get details about a specific browser session by ID Parameters ---------- browser_session_id : str The ID of the browser session. browser_session_id starts with `pbs_` request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- BrowserSessionResponse Successfully retrieved browser session details Examples -------- from skyvern import Skyvern client = Skyvern( api_key="YOUR_API_KEY", authorization="YOUR_AUTHORIZATION", ) client.browser_session.get_browser_session( browser_session_id="pbs_123456", ) """ _response = self._client_wrapper.httpx_client.request( f"v1/browser_sessions/{jsonable_encoder(browser_session_id)}", method="GET", request_options=request_options, ) try: if 200 <= _response.status_code < 300: return typing.cast( BrowserSessionResponse, parse_obj_as( type_=BrowserSessionResponse, # type: ignore object_=_response.json(), ), ) if _response.status_code == 403: raise ForbiddenError( typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ) ) if _response.status_code == 404: raise NotFoundError( typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ) ) if _response.status_code == 422: raise UnprocessableEntityError( typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ) ) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, body=_response.text) raise ApiError(status_code=_response.status_code, body=_response_json) class AsyncBrowserSessionClient: def __init__(self, *, client_wrapper: AsyncClientWrapper): self._client_wrapper = client_wrapper async def get_browser_sessions( self, *, request_options: typing.Optional[RequestOptions] = None ) -> typing.List[BrowserSessionResponse]: """ Get all active browser sessions for the organization Parameters ---------- request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- typing.List[BrowserSessionResponse] Successfully retrieved all active browser sessions Examples -------- import asyncio from skyvern import AsyncSkyvern client = AsyncSkyvern( api_key="YOUR_API_KEY", authorization="YOUR_AUTHORIZATION", ) async def main() -> None: await client.browser_session.get_browser_sessions() asyncio.run(main()) """ _response = await self._client_wrapper.httpx_client.request( "v1/browser_sessions", method="GET", request_options=request_options, ) try: if 200 <= _response.status_code < 300: return typing.cast( typing.List[BrowserSessionResponse], parse_obj_as( type_=typing.List[BrowserSessionResponse], # type: ignore object_=_response.json(), ), ) if _response.status_code == 403: raise ForbiddenError( typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ) ) if _response.status_code == 422: raise UnprocessableEntityError( typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ) ) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, body=_response.text) raise ApiError(status_code=_response.status_code, body=_response_json) async def create_browser_session( self, *, timeout: typing.Optional[int] = OMIT, request_options: typing.Optional[RequestOptions] = None ) -> BrowserSessionResponse: """ Create a new browser session Parameters ---------- timeout : typing.Optional[int] Timeout in minutes for the session. Timeout is applied after the session is started. Must be between 5 and 10080. Defaults to 60. request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- BrowserSessionResponse Successfully created browser session Examples -------- import asyncio from skyvern import AsyncSkyvern client = AsyncSkyvern( api_key="YOUR_API_KEY", authorization="YOUR_AUTHORIZATION", ) async def main() -> None: await client.browser_session.create_browser_session() asyncio.run(main()) """ _response = await self._client_wrapper.httpx_client.request( "v1/browser_sessions", method="POST", json={ "timeout": timeout, }, headers={ "content-type": "application/json", }, request_options=request_options, omit=OMIT, ) try: if 200 <= _response.status_code < 300: return typing.cast( BrowserSessionResponse, parse_obj_as( type_=BrowserSessionResponse, # type: ignore object_=_response.json(), ), ) if _response.status_code == 403: raise ForbiddenError( typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ) ) if _response.status_code == 422: raise UnprocessableEntityError( typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ) ) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, body=_response.text) raise ApiError(status_code=_response.status_code, body=_response_json) async def close_browser_session( self, browser_session_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> typing.Optional[typing.Any]: """ Close a browser session Parameters ---------- browser_session_id : str The ID of the browser session to close. completed_at will be set when the browser session is closed. browser_session_id starts with `pbs_` request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- typing.Optional[typing.Any] Successfully closed browser session Examples -------- import asyncio from skyvern import AsyncSkyvern client = AsyncSkyvern( api_key="YOUR_API_KEY", authorization="YOUR_AUTHORIZATION", ) async def main() -> None: await client.browser_session.close_browser_session( browser_session_id="pbs_123456", ) asyncio.run(main()) """ _response = await self._client_wrapper.httpx_client.request( f"v1/browser_sessions/{jsonable_encoder(browser_session_id)}/close", method="POST", request_options=request_options, ) try: if 200 <= _response.status_code < 300: return typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ) if _response.status_code == 403: raise ForbiddenError( typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ) ) if _response.status_code == 422: raise UnprocessableEntityError( typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ) ) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, body=_response.text) raise ApiError(status_code=_response.status_code, body=_response_json) async def get_browser_session( self, browser_session_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> BrowserSessionResponse: """ Get details about a specific browser session by ID Parameters ---------- browser_session_id : str The ID of the browser session. browser_session_id starts with `pbs_` request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- BrowserSessionResponse Successfully retrieved browser session details Examples -------- import asyncio from skyvern import AsyncSkyvern client = AsyncSkyvern( api_key="YOUR_API_KEY", authorization="YOUR_AUTHORIZATION", ) async def main() -> None: await client.browser_session.get_browser_session( browser_session_id="pbs_123456", ) asyncio.run(main()) """ _response = await self._client_wrapper.httpx_client.request( f"v1/browser_sessions/{jsonable_encoder(browser_session_id)}", method="GET", request_options=request_options, ) try: if 200 <= _response.status_code < 300: return typing.cast( BrowserSessionResponse, parse_obj_as( type_=BrowserSessionResponse, # type: ignore object_=_response.json(), ), ) if _response.status_code == 403: raise ForbiddenError( typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ) ) if _response.status_code == 404: raise NotFoundError( typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ) ) if _response.status_code == 422: raise UnprocessableEntityError( typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ) ) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, body=_response.text) raise ApiError(status_code=_response.status_code, body=_response_json)