feat: Add opt-in record_session flag to managed auth

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 112
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel/kernel-38c6ce8b0ce54e6c62517b9635acaf65369c26cdb1b55eb66290c13a8ab2b33d.yml
-openapi_spec_hash: e6f6ed157b1e318d1a1db72fd1d27091
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel/kernel-64dac369ae935b0318cd611e1735d45359a663eb55cf43fbb8b09e9dd814d7a2.yml
+openapi_spec_hash: cc0c6a4e716977df4b9eab5f4658d41b
 config_hash: 08d55086449943a8fec212b870061a3f

src/kernel/resources/auth/connections.py

@@ -66,6 +66,7 @@ def create(
         health_check_interval: int | Omit = omit,
         login_url: str | Omit = omit,
         proxy: connection_create_params.Proxy | Omit = omit,
+        record_session: bool | Omit = omit,
         save_credentials: bool | Omit = omit,
         # 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.
@@ -122,6 +123,9 @@ def create(
           proxy: Proxy selection. Provide either id or name. The proxy must belong to the
               caller's org.
 
+          record_session: Whether to record browser sessions for this connection by default. Useful for
+              debugging. Can be overridden per-login. Defaults to false.
+
           save_credentials: Whether to save credentials after every successful login. Defaults to true.
               One-time codes (TOTP, SMS, etc.) are not saved.
 
@@ -144,6 +148,7 @@ def create(
                     "health_check_interval": health_check_interval,
                     "login_url": login_url,
                     "proxy": proxy,
+                    "record_session": record_session,
                     "save_credentials": save_credentials,
                 },
                 connection_create_params.ConnectionCreateParams,
@@ -198,6 +203,7 @@ def update(
         health_check_interval: int | Omit = omit,
         login_url: str | Omit = omit,
         proxy: connection_update_params.Proxy | Omit = omit,
+        record_session: bool | Omit = omit,
         save_credentials: bool | Omit = omit,
         # 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.
@@ -228,6 +234,8 @@ def update(
           proxy: Proxy selection. Provide either id or name. The proxy must belong to the
               caller's org.
 
+          record_session: Whether to record browser sessions for this connection by default
+
           save_credentials: Whether to save credentials after every successful login
 
           extra_headers: Send extra headers
@@ -249,6 +257,7 @@ def update(
                     "health_check_interval": health_check_interval,
                     "login_url": login_url,
                     "proxy": proxy,
+                    "record_session": record_session,
                     "save_credentials": save_credentials,
                 },
                 connection_update_params.ConnectionUpdateParams,
@@ -398,6 +407,7 @@ def login(
         id: str,
         *,
         proxy: connection_login_params.Proxy | Omit = omit,
+        record_session: bool | Omit = omit,
         # 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,
@@ -415,6 +425,9 @@ def login(
           proxy: Proxy selection. Provide either id or name. The proxy must belong to the
               caller's org.
 
+          record_session: Override the connection's default for recording this login's browser session.
+              When omitted, the connection's record_session default is used.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -427,7 +440,13 @@ def login(
             raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
         return self._post(
             path_template("/auth/connections/{id}/login", id=id),
-            body=maybe_transform({"proxy": proxy}, connection_login_params.ConnectionLoginParams),
+            body=maybe_transform(
+                {
+                    "proxy": proxy,
+                    "record_session": record_session,
+                },
+                connection_login_params.ConnectionLoginParams,
+            ),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -529,6 +548,7 @@ async def create(
         health_check_interval: int | Omit = omit,
         login_url: str | Omit = omit,
         proxy: connection_create_params.Proxy | Omit = omit,
+        record_session: bool | Omit = omit,
         save_credentials: bool | Omit = omit,
         # 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.
@@ -585,6 +605,9 @@ async def create(
           proxy: Proxy selection. Provide either id or name. The proxy must belong to the
               caller's org.
 
+          record_session: Whether to record browser sessions for this connection by default. Useful for
+              debugging. Can be overridden per-login. Defaults to false.
+
           save_credentials: Whether to save credentials after every successful login. Defaults to true.
               One-time codes (TOTP, SMS, etc.) are not saved.
 
@@ -607,6 +630,7 @@ async def create(
                     "health_check_interval": health_check_interval,
                     "login_url": login_url,
                     "proxy": proxy,
+                    "record_session": record_session,
                     "save_credentials": save_credentials,
                 },
                 connection_create_params.ConnectionCreateParams,
@@ -661,6 +685,7 @@ async def update(
         health_check_interval: int | Omit = omit,
         login_url: str | Omit = omit,
         proxy: connection_update_params.Proxy | Omit = omit,
+        record_session: bool | Omit = omit,
         save_credentials: bool | Omit = omit,
         # 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.
@@ -691,6 +716,8 @@ async def update(
           proxy: Proxy selection. Provide either id or name. The proxy must belong to the
               caller's org.
 
+          record_session: Whether to record browser sessions for this connection by default
+
           save_credentials: Whether to save credentials after every successful login
 
           extra_headers: Send extra headers
@@ -712,6 +739,7 @@ async def update(
                     "health_check_interval": health_check_interval,
                     "login_url": login_url,
                     "proxy": proxy,
+                    "record_session": record_session,
                     "save_credentials": save_credentials,
                 },
                 connection_update_params.ConnectionUpdateParams,
@@ -861,6 +889,7 @@ async def login(
         id: str,
         *,
         proxy: connection_login_params.Proxy | Omit = omit,
+        record_session: bool | Omit = omit,
         # 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,
@@ -878,6 +907,9 @@ async def login(
           proxy: Proxy selection. Provide either id or name. The proxy must belong to the
               caller's org.
 
+          record_session: Override the connection's default for recording this login's browser session.
+              When omitted, the connection's record_session default is used.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -890,7 +922,13 @@ async def login(
             raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
         return await self._post(
             path_template("/auth/connections/{id}/login", id=id),
-            body=await async_maybe_transform({"proxy": proxy}, connection_login_params.ConnectionLoginParams),
+            body=await async_maybe_transform(
+                {
+                    "proxy": proxy,
+                    "record_session": record_session,
+                },
+                connection_login_params.ConnectionLoginParams,
+            ),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),

src/kernel/types/auth/connection_create_params.py

@@ -66,6 +66,12 @@ class ConnectionCreateParams(TypedDict, total=False):
     Provide either id or name. The proxy must belong to the caller's org.
     """
 
+    record_session: bool
+    """Whether to record browser sessions for this connection by default.
+
+    Useful for debugging. Can be overridden per-login. Defaults to false.
+    """
+
     save_credentials: bool
     """Whether to save credentials after every successful login.
 

src/kernel/types/auth/connection_login_params.py

@@ -14,6 +14,12 @@ class ConnectionLoginParams(TypedDict, total=False):
     Provide either id or name. The proxy must belong to the caller's org.
     """
 
+    record_session: bool
+    """Override the connection's default for recording this login's browser session.
+
+    When omitted, the connection's record_session default is used.
+    """
+
 
 class Proxy(TypedDict, total=False):
     """Proxy selection.

src/kernel/types/auth/connection_update_params.py

@@ -33,6 +33,9 @@ class ConnectionUpdateParams(TypedDict, total=False):
     Provide either id or name. The proxy must belong to the caller's org.
     """
 
+    record_session: bool
+    """Whether to record browser sessions for this connection by default"""
+
     save_credentials: bool
     """Whether to save credentials after every successful login"""
 

src/kernel/types/auth/managed_auth.py

@@ -130,6 +130,12 @@ class ManagedAuth(BaseModel):
     profile_name: str
     """Name of the profile associated with this auth connection"""
 
+    record_session: bool
+    """
+    Whether browser sessions for this connection are recorded by default for
+    debugging. Can be overridden per-login.
+    """
+
     save_credentials: bool
     """Whether credentials are saved after every successful login.
 

tests/api_resources/auth/test_connections.py

@@ -50,6 +50,7 @@ def test_method_create_with_all_params(self, client: Kernel) -> None:
                 "id": "id",
                 "name": "name",
             },
+            record_session=False,
             save_credentials=True,
         )
         assert_matches_type(ManagedAuth, connection, path=["response"])
@@ -150,6 +151,7 @@ def test_method_update_with_all_params(self, client: Kernel) -> None:
                 "id": "id",
                 "name": "name",
             },
+            record_session=False,
             save_credentials=True,
         )
         assert_matches_type(ManagedAuth, connection, path=["response"])
@@ -327,6 +329,7 @@ def test_method_login_with_all_params(self, client: Kernel) -> None:
                 "id": "id",
                 "name": "name",
             },
+            record_session=True,
         )
         assert_matches_type(LoginResponse, connection, path=["response"])
 
@@ -456,6 +459,7 @@ async def test_method_create_with_all_params(self, async_client: AsyncKernel) ->
                 "id": "id",
                 "name": "name",
             },
+            record_session=False,
             save_credentials=True,
         )
         assert_matches_type(ManagedAuth, connection, path=["response"])
@@ -556,6 +560,7 @@ async def test_method_update_with_all_params(self, async_client: AsyncKernel) ->
                 "id": "id",
                 "name": "name",
             },
+            record_session=False,
             save_credentials=True,
         )
         assert_matches_type(ManagedAuth, connection, path=["response"])
@@ -733,6 +738,7 @@ async def test_method_login_with_all_params(self, async_client: AsyncKernel) ->
                 "id": "id",
                 "name": "name",
             },
+            record_session=True,
         )
         assert_matches_type(LoginResponse, connection, path=["response"])