Skip to content

Commit 7ff0bdf

Browse files
stainless-app[bot]stainless-app[bot]
committed
feat: api: paginate GET /proxies
1 parent 44c4dd6 commit 7ff0bdf

7 files changed

Lines changed: 134 additions & 46 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-33e46e6a0095c2ec39a51860ee4e133c5a21a80a90cbe9e52953c07e5e0295de.yml
3-
openapi_spec_hash: 4aa466b9af39768b65a44b68ae0d1f6e
4-
config_hash: ede72e4ae65cc5a6d6927938b3455c46
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel/kernel-f3e52a8a9d9e37f8b527bdcce63b39cf8807d138cf3570c9954ba7f42ef02375.yml
3+
openapi_spec_hash: 2b787691eba1bb7bafb553528c09d5c0
4+
config_hash: e12afec516ced9520590c7a05af7a6f7

‎api.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -324,7 +324,7 @@ Methods:
324324

325325
- <code title="post /proxies">client.proxies.<a href="./src/kernel/resources/proxies.py">create</a>(\*\*<a href="src/kernel/types/proxy_create_params.py">params</a>) -> <a href="./src/kernel/types/proxy_create_response.py">ProxyCreateResponse</a></code>
326326
- <code title="get /proxies/{id}">client.proxies.<a href="./src/kernel/resources/proxies.py">retrieve</a>(id) -> <a href="./src/kernel/types/proxy_retrieve_response.py">ProxyRetrieveResponse</a></code>
327-
- <code title="get /proxies">client.proxies.<a href="./src/kernel/resources/proxies.py">list</a>() -> <a href="./src/kernel/types/proxy_list_response.py">ProxyListResponse</a></code>
327+
- <code title="get /proxies">client.proxies.<a href="./src/kernel/resources/proxies.py">list</a>(\*\*<a href="src/kernel/types/proxy_list_params.py">params</a>) -> <a href="./src/kernel/types/proxy_list_response.py">SyncOffsetPagination[ProxyListResponse]</a></code>
328328
- <code title="delete /proxies/{id}">client.proxies.<a href="./src/kernel/resources/proxies.py">delete</a>(id) -> None</code>
329329
- <code title="post /proxies/{id}/check">client.proxies.<a href="./src/kernel/resources/proxies.py">check</a>(id, \*\*<a href="src/kernel/types/proxy_check_params.py">params</a>) -> <a href="./src/kernel/types/proxy_check_response.py">ProxyCheckResponse</a></code>
330330

‎src/kernel/resources/proxies.py‎

Lines changed: 70 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
import httpx
88

9-
from ..types import proxy_check_params, proxy_create_params
9+
from ..types import proxy_list_params, proxy_check_params, proxy_create_params
1010
from .._types import Body, Omit, Query, Headers, NoneType, NotGiven, SequenceNotStr, omit, not_given
1111
from .._utils import path_template, maybe_transform, async_maybe_transform
1212
from .._compat import cached_property
@@ -17,7 +17,8 @@
1717
async_to_raw_response_wrapper,
1818
async_to_streamed_response_wrapper,
1919
)
20-
from .._base_client import make_request_options
20+
from ..pagination import SyncOffsetPagination, AsyncOffsetPagination
21+
from .._base_client import AsyncPaginator, make_request_options
2122
from ..types.proxy_list_response import ProxyListResponse
2223
from ..types.proxy_check_response import ProxyCheckResponse
2324
from ..types.proxy_create_response import ProxyCreateResponse
@@ -140,20 +141,48 @@ def retrieve(
140141
def list(
141142
self,
142143
*,
144+
limit: int | Omit = omit,
145+
offset: int | Omit = omit,
143146
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
144147
# The extra values given here take precedence over values defined on the client or passed to this method.
145148
extra_headers: Headers | None = None,
146149
extra_query: Query | None = None,
147150
extra_body: Body | None = None,
148151
timeout: float | httpx.Timeout | None | NotGiven = not_given,
149-
) -> ProxyListResponse:
150-
"""List proxies owned by the caller's organization."""
151-
return self._get(
152+
) -> SyncOffsetPagination[ProxyListResponse]:
153+
"""
154+
List proxies owned by the caller's organization.
155+
156+
Args:
157+
limit: Limit the number of proxies to return.
158+
159+
offset: Offset the number of proxies to return.
160+
161+
extra_headers: Send extra headers
162+
163+
extra_query: Add additional query parameters to the request
164+
165+
extra_body: Add additional JSON properties to the request
166+
167+
timeout: Override the client-level default timeout for this request, in seconds
168+
"""
169+
return self._get_api_list(
152170
"/proxies",
171+
page=SyncOffsetPagination[ProxyListResponse],
153172
options=make_request_options(
154-
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
173+
extra_headers=extra_headers,
174+
extra_query=extra_query,
175+
extra_body=extra_body,
176+
timeout=timeout,
177+
query=maybe_transform(
178+
{
179+
"limit": limit,
180+
"offset": offset,
181+
},
182+
proxy_list_params.ProxyListParams,
183+
),
155184
),
156-
cast_to=ProxyListResponse,
185+
model=ProxyListResponse,
157186
)
158187

159188
def delete(
@@ -357,23 +386,51 @@ async def retrieve(
357386
cast_to=ProxyRetrieveResponse,
358387
)
359388

360-
async def list(
389+
def list(
361390
self,
362391
*,
392+
limit: int | Omit = omit,
393+
offset: int | Omit = omit,
363394
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
364395
# The extra values given here take precedence over values defined on the client or passed to this method.
365396
extra_headers: Headers | None = None,
366397
extra_query: Query | None = None,
367398
extra_body: Body | None = None,
368399
timeout: float | httpx.Timeout | None | NotGiven = not_given,
369-
) -> ProxyListResponse:
370-
"""List proxies owned by the caller's organization."""
371-
return await self._get(
400+
) -> AsyncPaginator[ProxyListResponse, AsyncOffsetPagination[ProxyListResponse]]:
401+
"""
402+
List proxies owned by the caller's organization.
403+
404+
Args:
405+
limit: Limit the number of proxies to return.
406+
407+
offset: Offset the number of proxies to return.
408+
409+
extra_headers: Send extra headers
410+
411+
extra_query: Add additional query parameters to the request
412+
413+
extra_body: Add additional JSON properties to the request
414+
415+
timeout: Override the client-level default timeout for this request, in seconds
416+
"""
417+
return self._get_api_list(
372418
"/proxies",
419+
page=AsyncOffsetPagination[ProxyListResponse],
373420
options=make_request_options(
374-
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
421+
extra_headers=extra_headers,
422+
extra_query=extra_query,
423+
extra_body=extra_body,
424+
timeout=timeout,
425+
query=maybe_transform(
426+
{
427+
"limit": limit,
428+
"offset": offset,
429+
},
430+
proxy_list_params.ProxyListParams,
431+
),
375432
),
376-
cast_to=ProxyListResponse,
433+
model=ProxyListResponse,
377434
)
378435

379436
async def delete(

‎src/kernel/types/__init__.py‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@
2525
from .created_api_key import CreatedAPIKey as CreatedAPIKey
2626
from .browser_pool_ref import BrowserPoolRef as BrowserPoolRef
2727
from .app_list_response import AppListResponse as AppListResponse
28+
from .proxy_list_params import ProxyListParams as ProxyListParams
2829
from .proxy_check_params import ProxyCheckParams as ProxyCheckParams
2930
from .api_key_list_params import APIKeyListParams as APIKeyListParams
3031
from .browser_curl_params import BrowserCurlParams as BrowserCurlParams

‎src/kernel/types/proxy_list_params.py‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2+
3+
from __future__ import annotations
4+
5+
from typing_extensions import TypedDict
6+
7+
__all__ = ["ProxyListParams"]
8+
9+
10+
class ProxyListParams(TypedDict, total=False):
11+
limit: int
12+
"""Limit the number of proxies to return."""
13+
14+
offset: int
15+
"""Offset the number of proxies to return."""

‎src/kernel/types/proxy_list_response.py‎

Lines changed: 19 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -8,31 +8,30 @@
88

99
__all__ = [
1010
"ProxyListResponse",
11-
"ProxyListResponseItem",
12-
"ProxyListResponseItemConfig",
13-
"ProxyListResponseItemConfigDatacenterProxyConfig",
14-
"ProxyListResponseItemConfigIspProxyConfig",
15-
"ProxyListResponseItemConfigResidentialProxyConfig",
16-
"ProxyListResponseItemConfigMobileProxyConfig",
17-
"ProxyListResponseItemConfigCustomProxyConfig",
11+
"Config",
12+
"ConfigDatacenterProxyConfig",
13+
"ConfigIspProxyConfig",
14+
"ConfigResidentialProxyConfig",
15+
"ConfigMobileProxyConfig",
16+
"ConfigCustomProxyConfig",
1817
]
1918

2019

21-
class ProxyListResponseItemConfigDatacenterProxyConfig(BaseModel):
20+
class ConfigDatacenterProxyConfig(BaseModel):
2221
"""Configuration for a datacenter proxy."""
2322

2423
country: Optional[str] = None
2524
"""ISO 3166 country code. Defaults to US if not provided."""
2625

2726

28-
class ProxyListResponseItemConfigIspProxyConfig(BaseModel):
27+
class ConfigIspProxyConfig(BaseModel):
2928
"""Configuration for an ISP proxy."""
3029

3130
country: Optional[str] = None
3231
"""ISO 3166 country code. Defaults to US if not provided."""
3332

3433

35-
class ProxyListResponseItemConfigResidentialProxyConfig(BaseModel):
34+
class ConfigResidentialProxyConfig(BaseModel):
3635
"""Configuration for residential proxies."""
3736

3837
asn: Optional[str] = None
@@ -57,7 +56,7 @@ class ProxyListResponseItemConfigResidentialProxyConfig(BaseModel):
5756
"""US ZIP code."""
5857

5958

60-
class ProxyListResponseItemConfigMobileProxyConfig(BaseModel):
59+
class ConfigMobileProxyConfig(BaseModel):
6160
"""Configuration for mobile proxies."""
6261

6362
city: Optional[str] = None
@@ -70,7 +69,7 @@ class ProxyListResponseItemConfigMobileProxyConfig(BaseModel):
7069
"""US-only state code. Mobile carrier routing can make observed geo vary."""
7170

7271

73-
class ProxyListResponseItemConfigCustomProxyConfig(BaseModel):
72+
class ConfigCustomProxyConfig(BaseModel):
7473
"""Configuration for a custom proxy (e.g., private proxy server)."""
7574

7675
host: str
@@ -86,16 +85,16 @@ class ProxyListResponseItemConfigCustomProxyConfig(BaseModel):
8685
"""Username for proxy authentication."""
8786

8887

89-
ProxyListResponseItemConfig: TypeAlias = Union[
90-
ProxyListResponseItemConfigDatacenterProxyConfig,
91-
ProxyListResponseItemConfigIspProxyConfig,
92-
ProxyListResponseItemConfigResidentialProxyConfig,
93-
ProxyListResponseItemConfigMobileProxyConfig,
94-
ProxyListResponseItemConfigCustomProxyConfig,
88+
Config: TypeAlias = Union[
89+
ConfigDatacenterProxyConfig,
90+
ConfigIspProxyConfig,
91+
ConfigResidentialProxyConfig,
92+
ConfigMobileProxyConfig,
93+
ConfigCustomProxyConfig,
9594
]
9695

9796

98-
class ProxyListResponseItem(BaseModel):
97+
class ProxyListResponse(BaseModel):
9998
"""Configuration for routing traffic through a proxy."""
10099

101100
type: Literal["datacenter", "isp", "residential", "mobile", "custom"]
@@ -110,7 +109,7 @@ class ProxyListResponseItem(BaseModel):
110109
bypass_hosts: Optional[List[str]] = None
111110
"""Hostnames that should bypass the parent proxy and connect directly."""
112111

113-
config: Optional[ProxyListResponseItemConfig] = None
112+
config: Optional[Config] = None
114113
"""Configuration specific to the selected proxy `type`."""
115114

116115
ip_address: Optional[str] = None
@@ -127,6 +126,3 @@ class ProxyListResponseItem(BaseModel):
127126

128127
status: Optional[Literal["available", "unavailable"]] = None
129128
"""Current health status of the proxy."""
130-
131-
132-
ProxyListResponse: TypeAlias = List[ProxyListResponseItem]

‎tests/api_resources/test_proxies.py‎

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
ProxyCreateResponse,
1616
ProxyRetrieveResponse,
1717
)
18+
from kernel.pagination import SyncOffsetPagination, AsyncOffsetPagination
1819

1920
base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010")
2021

@@ -114,7 +115,16 @@ def test_path_params_retrieve(self, client: Kernel) -> None:
114115
@parametrize
115116
def test_method_list(self, client: Kernel) -> None:
116117
proxy = client.proxies.list()
117-
assert_matches_type(ProxyListResponse, proxy, path=["response"])
118+
assert_matches_type(SyncOffsetPagination[ProxyListResponse], proxy, path=["response"])
119+
120+
@pytest.mark.skip(reason="Mock server tests are disabled")
121+
@parametrize
122+
def test_method_list_with_all_params(self, client: Kernel) -> None:
123+
proxy = client.proxies.list(
124+
limit=1,
125+
offset=0,
126+
)
127+
assert_matches_type(SyncOffsetPagination[ProxyListResponse], proxy, path=["response"])
118128

119129
@pytest.mark.skip(reason="Mock server tests are disabled")
120130
@parametrize
@@ -124,7 +134,7 @@ def test_raw_response_list(self, client: Kernel) -> None:
124134
assert response.is_closed is True
125135
assert response.http_request.headers.get("X-Stainless-Lang") == "python"
126136
proxy = response.parse()
127-
assert_matches_type(ProxyListResponse, proxy, path=["response"])
137+
assert_matches_type(SyncOffsetPagination[ProxyListResponse], proxy, path=["response"])
128138

129139
@pytest.mark.skip(reason="Mock server tests are disabled")
130140
@parametrize
@@ -134,7 +144,7 @@ def test_streaming_response_list(self, client: Kernel) -> None:
134144
assert response.http_request.headers.get("X-Stainless-Lang") == "python"
135145

136146
proxy = response.parse()
137-
assert_matches_type(ProxyListResponse, proxy, path=["response"])
147+
assert_matches_type(SyncOffsetPagination[ProxyListResponse], proxy, path=["response"])
138148

139149
assert cast(Any, response.is_closed) is True
140150

@@ -329,7 +339,16 @@ async def test_path_params_retrieve(self, async_client: AsyncKernel) -> None:
329339
@parametrize
330340
async def test_method_list(self, async_client: AsyncKernel) -> None:
331341
proxy = await async_client.proxies.list()
332-
assert_matches_type(ProxyListResponse, proxy, path=["response"])
342+
assert_matches_type(AsyncOffsetPagination[ProxyListResponse], proxy, path=["response"])
343+
344+
@pytest.mark.skip(reason="Mock server tests are disabled")
345+
@parametrize
346+
async def test_method_list_with_all_params(self, async_client: AsyncKernel) -> None:
347+
proxy = await async_client.proxies.list(
348+
limit=1,
349+
offset=0,
350+
)
351+
assert_matches_type(AsyncOffsetPagination[ProxyListResponse], proxy, path=["response"])
333352

334353
@pytest.mark.skip(reason="Mock server tests are disabled")
335354
@parametrize
@@ -339,7 +358,7 @@ async def test_raw_response_list(self, async_client: AsyncKernel) -> None:
339358
assert response.is_closed is True
340359
assert response.http_request.headers.get("X-Stainless-Lang") == "python"
341360
proxy = await response.parse()
342-
assert_matches_type(ProxyListResponse, proxy, path=["response"])
361+
assert_matches_type(AsyncOffsetPagination[ProxyListResponse], proxy, path=["response"])
343362

344363
@pytest.mark.skip(reason="Mock server tests are disabled")
345364
@parametrize
@@ -349,7 +368,7 @@ async def test_streaming_response_list(self, async_client: AsyncKernel) -> None:
349368
assert response.http_request.headers.get("X-Stainless-Lang") == "python"
350369

351370
proxy = await response.parse()
352-
assert_matches_type(ProxyListResponse, proxy, path=["response"])
371+
assert_matches_type(AsyncOffsetPagination[ProxyListResponse], proxy, path=["response"])
353372

354373
assert cast(Any, response.is_closed) is True
355374

0 commit comments

Comments
 (0)