feat(api): api update (#105)

Author: stainless-app[bot]

.stats.yml

@@ -1,2 +1,2 @@
-configured_endpoints: 9
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/nen-labs%2Fsteel-52530c249d6af17095f89d698ba795846df15a0cada81db021d8919e25d6d9d5.yml
+configured_endpoints: 11
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/nen-labs%2Fsteel-eeb1e8ae03bb1dd924b05f4a631d38d5f1fdeb8926168ce63b95d8445df2d359.yml

api.md

@@ -21,6 +21,8 @@ from steel.types import (
     Session,
     SessionContext,
     Sessionslist,
+    SessionEventsResponse,
+    SessionLiveDetailsResponse,
     SessionReleaseResponse,
     SessionReleaseAllResponse,
 )
@@ -32,5 +34,7 @@ Methods:
 - <code title="get /v1/sessions/{id}">client.sessions.<a href="./src/steel/resources/sessions.py">retrieve</a>(id) -> <a href="./src/steel/types/session.py">Session</a></code>
 - <code title="get /v1/sessions">client.sessions.<a href="./src/steel/resources/sessions.py">list</a>(\*\*<a href="src/steel/types/session_list_params.py">params</a>) -> SyncSessionsCursor[Session]</code>
 - <code title="get /v1/sessions/{id}/context">client.sessions.<a href="./src/steel/resources/sessions.py">context</a>(id) -> <a href="./src/steel/types/session_context.py">SessionContext</a></code>
+- <code title="get /v1/sessions/{id}/events">client.sessions.<a href="./src/steel/resources/sessions.py">events</a>(id) -> <a href="./src/steel/types/session_events_response.py">SessionEventsResponse</a></code>
+- <code title="get /v1/sessions/{id}/live-details">client.sessions.<a href="./src/steel/resources/sessions.py">live_details</a>(id) -> <a href="./src/steel/types/session_live_details_response.py">SessionLiveDetailsResponse</a></code>
 - <code title="post /v1/sessions/{id}/release">client.sessions.<a href="./src/steel/resources/sessions.py">release</a>(id) -> <a href="./src/steel/types/session_release_response.py">SessionReleaseResponse</a></code>
 - <code title="post /v1/sessions/release">client.sessions.<a href="./src/steel/resources/sessions.py">release_all</a>() -> <a href="./src/steel/types/session_release_all_response.py">SessionReleaseAllResponse</a></code>

src/steel/resources/sessions.py

@@ -25,8 +25,10 @@
 from ..types.session import Session as TypesSession
 from ..types.sessionslist import Session as SessionslistSession
 from ..types.session_context import SessionContext
+from ..types.session_events_response import SessionEventsResponse
 from ..types.session_release_response import SessionReleaseResponse
 from ..types.session_release_all_response import SessionReleaseAllResponse
+from ..types.session_live_details_response import SessionLiveDetailsResponse
 
 __all__ = ["SessionsResource", "AsyncSessionsResource"]
 
@@ -252,6 +254,72 @@ def context(
             cast_to=SessionContext,
         )
 
+    def events(
+        self,
+        id: str,
+        *,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> SessionEventsResponse:
+        """
+        This endpoint allows you to get the recorded session events in the RRWeb format
+
+        Args:
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        return self._get(
+            f"/v1/sessions/{id}/events",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=SessionEventsResponse,
+        )
+
+    def live_details(
+        self,
+        id: str,
+        *,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> SessionLiveDetailsResponse:
+        """
+        Returns the live state of the session, including pages, tabs, and browser state
+
+        Args:
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        return self._get(
+            f"/v1/sessions/{id}/live-details",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=SessionLiveDetailsResponse,
+        )
+
     def release(
         self,
         id: str,
@@ -526,6 +594,72 @@ async def context(
             cast_to=SessionContext,
         )
 
+    async def events(
+        self,
+        id: str,
+        *,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> SessionEventsResponse:
+        """
+        This endpoint allows you to get the recorded session events in the RRWeb format
+
+        Args:
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        return await self._get(
+            f"/v1/sessions/{id}/events",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=SessionEventsResponse,
+        )
+
+    async def live_details(
+        self,
+        id: str,
+        *,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> SessionLiveDetailsResponse:
+        """
+        Returns the live state of the session, including pages, tabs, and browser state
+
+        Args:
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        return await self._get(
+            f"/v1/sessions/{id}/live-details",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=SessionLiveDetailsResponse,
+        )
+
     async def release(
         self,
         id: str,
@@ -595,6 +729,12 @@ def __init__(self, sessions: SessionsResource) -> None:
         self.context = to_raw_response_wrapper(
             sessions.context,
         )
+        self.events = to_raw_response_wrapper(
+            sessions.events,
+        )
+        self.live_details = to_raw_response_wrapper(
+            sessions.live_details,
+        )
         self.release = to_raw_response_wrapper(
             sessions.release,
         )
@@ -619,6 +759,12 @@ def __init__(self, sessions: AsyncSessionsResource) -> None:
         self.context = async_to_raw_response_wrapper(
             sessions.context,
         )
+        self.events = async_to_raw_response_wrapper(
+            sessions.events,
+        )
+        self.live_details = async_to_raw_response_wrapper(
+            sessions.live_details,
+        )
         self.release = async_to_raw_response_wrapper(
             sessions.release,
         )
@@ -643,6 +789,12 @@ def __init__(self, sessions: SessionsResource) -> None:
         self.context = to_streamed_response_wrapper(
             sessions.context,
         )
+        self.events = to_streamed_response_wrapper(
+            sessions.events,
+        )
+        self.live_details = to_streamed_response_wrapper(
+            sessions.live_details,
+        )
         self.release = to_streamed_response_wrapper(
             sessions.release,
         )
@@ -667,6 +819,12 @@ def __init__(self, sessions: AsyncSessionsResource) -> None:
         self.context = async_to_streamed_response_wrapper(
             sessions.context,
         )
+        self.events = async_to_streamed_response_wrapper(
+            sessions.events,
+        )
+        self.live_details = async_to_streamed_response_wrapper(
+            sessions.live_details,
+        )
         self.release = async_to_streamed_response_wrapper(
             sessions.release,
         )

src/steel/types/__init__.py

@@ -12,6 +12,8 @@
 from .session_list_params import SessionListParams as SessionListParams
 from .client_scrape_params import ClientScrapeParams as ClientScrapeParams
 from .session_create_params import SessionCreateParams as SessionCreateParams
+from .session_events_response import SessionEventsResponse as SessionEventsResponse
 from .client_screenshot_params import ClientScreenshotParams as ClientScreenshotParams
 from .session_release_response import SessionReleaseResponse as SessionReleaseResponse
 from .session_release_all_response import SessionReleaseAllResponse as SessionReleaseAllResponse
+from .session_live_details_response import SessionLiveDetailsResponse as SessionLiveDetailsResponse

src/steel/types/session_events_response.py

@@ -0,0 +1,8 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List
+from typing_extensions import TypeAlias
+
+__all__ = ["SessionEventsResponse"]
+
+SessionEventsResponse: TypeAlias = List[Dict[str, object]]

src/steel/types/session_live_details_response.py

@@ -0,0 +1,33 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = ["SessionLiveDetailsResponse", "Page"]
+
+
+class Page(BaseModel):
+    id: str
+
+    favicon: Optional[str] = None
+
+    session_viewer_fullscreen_url: str = FieldInfo(alias="sessionViewerFullscreenUrl")
+
+    session_viewer_url: str = FieldInfo(alias="sessionViewerUrl")
+
+    title: str
+
+    url: str
+
+
+class SessionLiveDetailsResponse(BaseModel):
+    pages: List[Page]
+
+    session_viewer_fullscreen_url: str = FieldInfo(alias="sessionViewerFullscreenUrl")
+
+    session_viewer_url: str = FieldInfo(alias="sessionViewerUrl")
+
+    ws_url: str = FieldInfo(alias="wsUrl")