Skip to content

Commit 4d072e8

Browse files
feat(api): support id-or-name lookup on browser session get/patch/delete
1 parent 0c17ce2 commit 4d072e8

4 files changed

Lines changed: 58 additions & 58 deletions

File tree

.stats.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 117
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel/kernel-662a9d6352d842f37e06e0197a61fe10850483302650713345d45780b3128343.yml
3-
openapi_spec_hash: e65977d16d95d48c75d02a1133131149
4-
config_hash: bb7acce8576a50dd449b0c8f58ef0f1d
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel/kernel-08c2d6a44f4cdcbfb6803a3043fdc1a3e33911dec4652cb3a870f01bc584421f.yml
3+
openapi_spec_hash: c816491451347eb93b793cddf6a78648
4+
config_hash: 9e45c27425021d49b5391f5cc980b046

api.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -95,11 +95,11 @@ from kernel.types import (
9595
Methods:
9696

9797
- <code title="post /browsers">client.browsers.<a href="./src/kernel/resources/browsers/browsers.py">create</a>(\*\*<a href="src/kernel/types/browser_create_params.py">params</a>) -> <a href="./src/kernel/types/browser_create_response.py">BrowserCreateResponse</a></code>
98-
- <code title="get /browsers/{id}">client.browsers.<a href="./src/kernel/resources/browsers/browsers.py">retrieve</a>(id, \*\*<a href="src/kernel/types/browser_retrieve_params.py">params</a>) -> <a href="./src/kernel/types/browser_retrieve_response.py">BrowserRetrieveResponse</a></code>
99-
- <code title="patch /browsers/{id}">client.browsers.<a href="./src/kernel/resources/browsers/browsers.py">update</a>(id, \*\*<a href="src/kernel/types/browser_update_params.py">params</a>) -> <a href="./src/kernel/types/browser_update_response.py">BrowserUpdateResponse</a></code>
98+
- <code title="get /browsers/{id_or_name}">client.browsers.<a href="./src/kernel/resources/browsers/browsers.py">retrieve</a>(id_or_name, \*\*<a href="src/kernel/types/browser_retrieve_params.py">params</a>) -> <a href="./src/kernel/types/browser_retrieve_response.py">BrowserRetrieveResponse</a></code>
99+
- <code title="patch /browsers/{id_or_name}">client.browsers.<a href="./src/kernel/resources/browsers/browsers.py">update</a>(id_or_name, \*\*<a href="src/kernel/types/browser_update_params.py">params</a>) -> <a href="./src/kernel/types/browser_update_response.py">BrowserUpdateResponse</a></code>
100100
- <code title="get /browsers">client.browsers.<a href="./src/kernel/resources/browsers/browsers.py">list</a>(\*\*<a href="src/kernel/types/browser_list_params.py">params</a>) -> <a href="./src/kernel/types/browser_list_response.py">SyncOffsetPagination[BrowserListResponse]</a></code>
101101
- <code title="post /browsers/{id}/curl">client.browsers.<a href="./src/kernel/resources/browsers/browsers.py">curl</a>(id, \*\*<a href="src/kernel/types/browser_curl_params.py">params</a>) -> <a href="./src/kernel/types/browser_curl_response.py">BrowserCurlResponse</a></code>
102-
- <code title="delete /browsers/{id}">client.browsers.<a href="./src/kernel/resources/browsers/browsers.py">delete_by_id</a>(id) -> None</code>
102+
- <code title="delete /browsers/{id_or_name}">client.browsers.<a href="./src/kernel/resources/browsers/browsers.py">delete_by_id</a>(id_or_name) -> None</code>
103103
- <code title="post /browsers/{id}/extensions">client.browsers.<a href="./src/kernel/resources/browsers/browsers.py">load_extensions</a>(id, \*\*<a href="src/kernel/types/browser_load_extensions_params.py">params</a>) -> None</code>
104104

105105
## Telemetry

src/kernel/resources/browsers/browsers.py

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -292,7 +292,7 @@ def create(
292292

293293
def retrieve(
294294
self,
295-
id: str,
295+
id_or_name: str,
296296
*,
297297
include_deleted: bool | Omit = omit,
298298
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -316,10 +316,10 @@ def retrieve(
316316
317317
timeout: Override the client-level default timeout for this request, in seconds
318318
"""
319-
if not id:
320-
raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
319+
if not id_or_name:
320+
raise ValueError(f"Expected a non-empty value for `id_or_name` but received {id_or_name!r}")
321321
return self._get(
322-
path_template("/browsers/{id}", id=id),
322+
path_template("/browsers/{id_or_name}", id_or_name=id_or_name),
323323
options=make_request_options(
324324
extra_headers=extra_headers,
325325
extra_query=extra_query,
@@ -334,7 +334,7 @@ def retrieve(
334334

335335
def update(
336336
self,
337-
id: str,
337+
id_or_name: str,
338338
*,
339339
disable_default_proxy: bool | Omit = omit,
340340
profile: BrowserProfile | Omit = omit,
@@ -377,10 +377,10 @@ def update(
377377
378378
timeout: Override the client-level default timeout for this request, in seconds
379379
"""
380-
if not id:
381-
raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
380+
if not id_or_name:
381+
raise ValueError(f"Expected a non-empty value for `id_or_name` but received {id_or_name!r}")
382382
return self._patch(
383-
path_template("/browsers/{id}", id=id),
383+
path_template("/browsers/{id_or_name}", id_or_name=id_or_name),
384384
body=maybe_transform(
385385
{
386386
"disable_default_proxy": disable_default_proxy,
@@ -590,7 +590,7 @@ def stream(
590590

591591
def delete_by_id(
592592
self,
593-
id: str,
593+
id_or_name: str,
594594
*,
595595
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
596596
# The extra values given here take precedence over values defined on the client or passed to this method.
@@ -600,7 +600,7 @@ def delete_by_id(
600600
timeout: float | httpx.Timeout | None | NotGiven = not_given,
601601
) -> None:
602602
"""
603-
Delete a browser session by ID
603+
Delete a browser session by ID or name
604604
605605
Args:
606606
extra_headers: Send extra headers
@@ -611,11 +611,11 @@ def delete_by_id(
611611
612612
timeout: Override the client-level default timeout for this request, in seconds
613613
"""
614-
if not id:
615-
raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
614+
if not id_or_name:
615+
raise ValueError(f"Expected a non-empty value for `id_or_name` but received {id_or_name!r}")
616616
extra_headers = {"Accept": "*/*", **(extra_headers or {})}
617617
return self._delete(
618-
path_template("/browsers/{id}", id=id),
618+
path_template("/browsers/{id_or_name}", id_or_name=id_or_name),
619619
options=make_request_options(
620620
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
621621
),
@@ -857,7 +857,7 @@ async def create(
857857

858858
async def retrieve(
859859
self,
860-
id: str,
860+
id_or_name: str,
861861
*,
862862
include_deleted: bool | Omit = omit,
863863
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -881,10 +881,10 @@ async def retrieve(
881881
882882
timeout: Override the client-level default timeout for this request, in seconds
883883
"""
884-
if not id:
885-
raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
884+
if not id_or_name:
885+
raise ValueError(f"Expected a non-empty value for `id_or_name` but received {id_or_name!r}")
886886
return await self._get(
887-
path_template("/browsers/{id}", id=id),
887+
path_template("/browsers/{id_or_name}", id_or_name=id_or_name),
888888
options=make_request_options(
889889
extra_headers=extra_headers,
890890
extra_query=extra_query,
@@ -899,7 +899,7 @@ async def retrieve(
899899

900900
async def update(
901901
self,
902-
id: str,
902+
id_or_name: str,
903903
*,
904904
disable_default_proxy: bool | Omit = omit,
905905
profile: BrowserProfile | Omit = omit,
@@ -942,10 +942,10 @@ async def update(
942942
943943
timeout: Override the client-level default timeout for this request, in seconds
944944
"""
945-
if not id:
946-
raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
945+
if not id_or_name:
946+
raise ValueError(f"Expected a non-empty value for `id_or_name` but received {id_or_name!r}")
947947
return await self._patch(
948-
path_template("/browsers/{id}", id=id),
948+
path_template("/browsers/{id_or_name}", id_or_name=id_or_name),
949949
body=await async_maybe_transform(
950950
{
951951
"disable_default_proxy": disable_default_proxy,
@@ -1155,7 +1155,7 @@ async def stream(
11551155

11561156
async def delete_by_id(
11571157
self,
1158-
id: str,
1158+
id_or_name: str,
11591159
*,
11601160
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
11611161
# The extra values given here take precedence over values defined on the client or passed to this method.
@@ -1165,7 +1165,7 @@ async def delete_by_id(
11651165
timeout: float | httpx.Timeout | None | NotGiven = not_given,
11661166
) -> None:
11671167
"""
1168-
Delete a browser session by ID
1168+
Delete a browser session by ID or name
11691169
11701170
Args:
11711171
extra_headers: Send extra headers
@@ -1176,11 +1176,11 @@ async def delete_by_id(
11761176
11771177
timeout: Override the client-level default timeout for this request, in seconds
11781178
"""
1179-
if not id:
1180-
raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
1179+
if not id_or_name:
1180+
raise ValueError(f"Expected a non-empty value for `id_or_name` but received {id_or_name!r}")
11811181
extra_headers = {"Accept": "*/*", **(extra_headers or {})}
11821182
return await self._delete(
1183-
path_template("/browsers/{id}", id=id),
1183+
path_template("/browsers/{id_or_name}", id_or_name=id_or_name),
11841184
options=make_request_options(
11851185
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
11861186
),

0 commit comments

Comments
 (0)