feat(docs): updating documented docs for stainless

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 10
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openint%2Fopenint-b1eb7e567b4189d22d4699483e51b8872be5ec24eb5f37384be637d1f11e2f26.yml
-openapi_spec_hash: fff7dab9505ebbf35885f0a7c65c8baf
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openint%2Fopenint-67a61cc981caf2a7992bcb19816e09474399f50cfa9a2a6cf2c79b8299a53d16.yml
+openapi_spec_hash: 32eae2c2f8547ef3ea3e395bf2f413e2
 config_hash: a6e549521fa293498319c532d9cfa93f

api.md

@@ -28,4 +28,4 @@ Methods:
 - <code title="get /viewer">client.<a href="./src/openint/_client.py">get_current_user</a>() -> <a href="./src/openint/types/get_current_user_response.py">GetCurrentUserResponse</a></code>
 - <code title="get /connector-config">client.<a href="./src/openint/_client.py">list_connection_configs</a>(\*\*<a href="src/openint/types/client_list_connection_configs_params.py">params</a>) -> <a href="./src/openint/types/list_connection_configs_response.py">SyncOffsetPagination[ListConnectionConfigsResponse]</a></code>
 - <code title="get /connection">client.<a href="./src/openint/_client.py">list_connections</a>(\*\*<a href="src/openint/types/client_list_connections_params.py">params</a>) -> <a href="./src/openint/types/list_connections_response.py">SyncOffsetPagination[ListConnectionsResponse]</a></code>
-- <code title="get /connector">client.<a href="./src/openint/_client.py">list_connectors</a>(\*\*<a href="src/openint/types/client_list_connectors_params.py">params</a>) -> <a href="./src/openint/types/list_connectors_response.py">ListConnectorsResponse</a></code>
+- <code title="get /connector">client.<a href="./src/openint/_client.py">list_connectors</a>(\*\*<a href="src/openint/types/client_list_connectors_params.py">params</a>) -> <a href="./src/openint/types/list_connectors_response.py">SyncOffsetPagination[ListConnectorsResponse]</a></code>

src/openint/_client.py

@@ -607,6 +607,10 @@ def list_connection_configs(
         List Configured Connectors
 
         Args:
+          limit: Limit the number of items returned
+
+          offset: Offset the items returned
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -729,6 +733,10 @@ def list_connections(
 
           expand: Expand the response with additional optionals
 
+          limit: Limit the number of items returned
+
+          offset: Offset the items returned
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -765,17 +773,23 @@ def list_connectors(
         self,
         *,
         expand: List[Literal["schemas"]] | NotGiven = NOT_GIVEN,
+        limit: int | NotGiven = NOT_GIVEN,
+        offset: int | NotGiven = NOT_GIVEN,
         # 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,
-    ) -> ListConnectorsResponse:
+    ) -> SyncOffsetPagination[ListConnectorsResponse]:
         """
         List all connectors to understand what integrations are available to configure
 
         Args:
+          limit: Limit the number of items returned
+
+          offset: Offset the items returned
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -784,16 +798,24 @@ def list_connectors(
 
           timeout: Override the client-level default timeout for this request, in seconds
         """
-        return self.get(
+        return self.get_api_list(
             "/connector",
+            page=SyncOffsetPagination[ListConnectorsResponse],
             options=make_request_options(
                 extra_headers=extra_headers,
                 extra_query=extra_query,
                 extra_body=extra_body,
                 timeout=timeout,
-                query=maybe_transform({"expand": expand}, client_list_connectors_params.ClientListConnectorsParams),
+                query=maybe_transform(
+                    {
+                        "expand": expand,
+                        "limit": limit,
+                        "offset": offset,
+                    },
+                    client_list_connectors_params.ClientListConnectorsParams,
+                ),
             ),
-            cast_to=ListConnectorsResponse,
+            model=ListConnectorsResponse,
         )
 
     @override
@@ -1369,6 +1391,10 @@ def list_connection_configs(
         List Configured Connectors
 
         Args:
+          limit: Limit the number of items returned
+
+          offset: Offset the items returned
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -1491,6 +1517,10 @@ def list_connections(
 
           expand: Expand the response with additional optionals
 
+          limit: Limit the number of items returned
+
+          offset: Offset the items returned
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -1523,21 +1553,27 @@ def list_connections(
             model=cast(Any, ListConnectionsResponse),  # Union types cannot be passed in as arguments in the type system
         )
 
-    async def list_connectors(
+    def list_connectors(
         self,
         *,
         expand: List[Literal["schemas"]] | NotGiven = NOT_GIVEN,
+        limit: int | NotGiven = NOT_GIVEN,
+        offset: int | NotGiven = NOT_GIVEN,
         # 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,
-    ) -> ListConnectorsResponse:
+    ) -> AsyncPaginator[ListConnectorsResponse, AsyncOffsetPagination[ListConnectorsResponse]]:
         """
         List all connectors to understand what integrations are available to configure
 
         Args:
+          limit: Limit the number of items returned
+
+          offset: Offset the items returned
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -1546,18 +1582,24 @@ async def list_connectors(
 
           timeout: Override the client-level default timeout for this request, in seconds
         """
-        return await self.get(
+        return self.get_api_list(
             "/connector",
+            page=AsyncOffsetPagination[ListConnectorsResponse],
             options=make_request_options(
                 extra_headers=extra_headers,
                 extra_query=extra_query,
                 extra_body=extra_body,
                 timeout=timeout,
-                query=await async_maybe_transform(
-                    {"expand": expand}, client_list_connectors_params.ClientListConnectorsParams
+                query=maybe_transform(
+                    {
+                        "expand": expand,
+                        "limit": limit,
+                        "offset": offset,
+                    },
+                    client_list_connectors_params.ClientListConnectorsParams,
                 ),
             ),
-            cast_to=ListConnectorsResponse,
+            model=ListConnectorsResponse,
         )
 
     @override

src/openint/types/client_list_connection_configs_params.py

@@ -73,5 +73,7 @@ class ClientListConnectionConfigsParams(TypedDict, total=False):
     expand: List[Literal["connector", "connector.schemas", "connection_count"]]
 
     limit: int
+    """Limit the number of items returned"""
 
     offset: int
+    """Offset the items returned"""

src/openint/types/client_list_connections_params.py

@@ -85,5 +85,7 @@ class ClientListConnectionsParams(TypedDict, total=False):
     include_secrets: bool
 
     limit: int
+    """Limit the number of items returned"""
 
     offset: int
+    """Offset the items returned"""

src/openint/types/client_list_connectors_params.py

@@ -10,3 +10,9 @@
 
 class ClientListConnectorsParams(TypedDict, total=False):
     expand: List[Literal["schemas"]]
+
+    limit: int
+    """Limit the number of items returned"""
+
+    offset: int
+    """Offset the items returned"""

src/openint/types/list_connectors_response.py

@@ -7,10 +7,10 @@
 
 from .._models import BaseModel
 
-__all__ = ["ListConnectorsResponse", "Item", "ItemIntegration", "ItemSchemas", "ItemScope"]
+__all__ = ["ListConnectorsResponse", "Integration", "Schemas", "Scope"]
 
 
-class ItemIntegration(BaseModel):
+class Integration(BaseModel):
     id: str
 
     connector_name: Literal[
@@ -95,7 +95,7 @@ class ItemIntegration(BaseModel):
     version: Optional[str] = None
 
 
-class ItemSchemas(BaseModel):
+class Schemas(BaseModel):
     connect_input: Optional[object] = None
 
     connect_output: Optional[object] = None
@@ -111,15 +111,15 @@ class ItemSchemas(BaseModel):
     webhook_input: Optional[object] = None
 
 
-class ItemScope(BaseModel):
+class Scope(BaseModel):
     scope: str
 
     description: Optional[str] = None
 
     display_name: Optional[str] = None
 
 
-class Item(BaseModel):
+class ListConnectorsResponse(BaseModel):
     name: str
 
     auth_type: Optional[Literal["BASIC", "OAUTH1", "OAUTH2", "OAUTH2CC", "API_KEY", "CUSTOM"]] = FieldInfo(
@@ -128,29 +128,16 @@ class Item(BaseModel):
 
     display_name: Optional[str] = None
 
-    integrations: Optional[List[ItemIntegration]] = None
+    integrations: Optional[List[Integration]] = None
 
     logo_url: Optional[str] = None
 
     openint_scopes: Optional[List[str]] = None
 
     platforms: Optional[List[Literal["web", "mobile", "desktop", "local", "cloud"]]] = None
 
-    schemas: Optional[ItemSchemas] = None
+    schemas: Optional[Schemas] = None
 
-    scopes: Optional[List[ItemScope]] = None
+    scopes: Optional[List[Scope]] = None
 
     stage: Optional[Literal["alpha", "beta", "ga", "hidden"]] = None
-
-
-class ListConnectorsResponse(BaseModel):
-    items: List[Item]
-
-    limit: int
-    """Limit the number of items returned"""
-
-    offset: int
-    """Offset the items returned"""
-
-    total: int
-    """Total number of items in the database for the organization"""

tests/api_resources/test_client.py

@@ -467,15 +467,17 @@ def test_streaming_response_list_connections(self, client: Openint) -> None:
     @parametrize
     def test_method_list_connectors(self, client: Openint) -> None:
         client_ = client.list_connectors()
-        assert_matches_type(ListConnectorsResponse, client_, path=["response"])
+        assert_matches_type(SyncOffsetPagination[ListConnectorsResponse], client_, path=["response"])
 
     @pytest.mark.skip()
     @parametrize
     def test_method_list_connectors_with_all_params(self, client: Openint) -> None:
         client_ = client.list_connectors(
             expand=["schemas"],
+            limit=0,
+            offset=0,
         )
-        assert_matches_type(ListConnectorsResponse, client_, path=["response"])
+        assert_matches_type(SyncOffsetPagination[ListConnectorsResponse], client_, path=["response"])
 
     @pytest.mark.skip()
     @parametrize
@@ -485,7 +487,7 @@ def test_raw_response_list_connectors(self, client: Openint) -> None:
         assert response.is_closed is True
         assert response.http_request.headers.get("X-Stainless-Lang") == "python"
         client_ = response.parse()
-        assert_matches_type(ListConnectorsResponse, client_, path=["response"])
+        assert_matches_type(SyncOffsetPagination[ListConnectorsResponse], client_, path=["response"])
 
     @pytest.mark.skip()
     @parametrize
@@ -495,7 +497,7 @@ def test_streaming_response_list_connectors(self, client: Openint) -> None:
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
 
             client_ = response.parse()
-            assert_matches_type(ListConnectorsResponse, client_, path=["response"])
+            assert_matches_type(SyncOffsetPagination[ListConnectorsResponse], client_, path=["response"])
 
         assert cast(Any, response.is_closed) is True
 
@@ -941,15 +943,17 @@ async def test_streaming_response_list_connections(self, async_client: AsyncOpen
     @parametrize
     async def test_method_list_connectors(self, async_client: AsyncOpenint) -> None:
         client = await async_client.list_connectors()
-        assert_matches_type(ListConnectorsResponse, client, path=["response"])
+        assert_matches_type(AsyncOffsetPagination[ListConnectorsResponse], client, path=["response"])
 
     @pytest.mark.skip()
     @parametrize
     async def test_method_list_connectors_with_all_params(self, async_client: AsyncOpenint) -> None:
         client = await async_client.list_connectors(
             expand=["schemas"],
+            limit=0,
+            offset=0,
         )
-        assert_matches_type(ListConnectorsResponse, client, path=["response"])
+        assert_matches_type(AsyncOffsetPagination[ListConnectorsResponse], client, path=["response"])
 
     @pytest.mark.skip()
     @parametrize
@@ -959,7 +963,7 @@ async def test_raw_response_list_connectors(self, async_client: AsyncOpenint) ->
         assert response.is_closed is True
         assert response.http_request.headers.get("X-Stainless-Lang") == "python"
         client = await response.parse()
-        assert_matches_type(ListConnectorsResponse, client, path=["response"])
+        assert_matches_type(AsyncOffsetPagination[ListConnectorsResponse], client, path=["response"])
 
     @pytest.mark.skip()
     @parametrize
@@ -969,6 +973,6 @@ async def test_streaming_response_list_connectors(self, async_client: AsyncOpeni
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
 
             client = await response.parse()
-            assert_matches_type(ListConnectorsResponse, client, path=["response"])
+            assert_matches_type(AsyncOffsetPagination[ListConnectorsResponse], client, path=["response"])
 
         assert cast(Any, response.is_closed) is True