feat(api): api update (#25)

Author: stainless-app[bot]

.stats.yml

@@ -1,2 +1,2 @@
-configured_endpoints: 3
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/hyperspell%2Fhyperspell-d975cb3c41e7b2790db4938b1de2b89c4005825a6347ae29ca4998f2c5b1a1be.yml
+configured_endpoints: 2
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/hyperspell%2Fhyperspell-363c228e40d56a22d2ffff0751e999364709fb95ff4bae587ce8659008d67323.yml

api.md

@@ -15,10 +15,9 @@ Methods:
 Types:
 
 ```python
-from hyperspell.types import Document, DocumentListResponse
+from hyperspell.types import Document
 ```
 
 Methods:
 
 - <code title="get /documents/get/{document_id}">client.documents.<a href="./src/hyperspell/resources/documents.py">retrieve</a>(document_id) -> <a href="./src/hyperspell/types/document.py">Document</a></code>
-- <code title="post /documents/list">client.documents.<a href="./src/hyperspell/resources/documents.py">list</a>(\*\*<a href="src/hyperspell/types/document_list_params.py">params</a>) -> <a href="./src/hyperspell/types/document_list_response.py">DocumentListResponse</a></code>

src/hyperspell/resources/documents.py

@@ -2,16 +2,9 @@
 
 from __future__ import annotations
 
-from typing import Optional
-
 import httpx
 
-from ..types import document_list_params
 from .._types import NOT_GIVEN, Body, Query, Headers, NotGiven
-from .._utils import (
-    maybe_transform,
-    async_maybe_transform,
-)
 from .._compat import cached_property
 from .._resource import SyncAPIResource, AsyncAPIResource
 from .._response import (
@@ -22,7 +15,6 @@
 )
 from .._base_client import make_request_options
 from ..types.document import Document
-from ..types.document_list_response import DocumentListResponse
 
 __all__ = ["DocumentsResource", "AsyncDocumentsResource"]
 
@@ -78,52 +70,6 @@ def retrieve(
             cast_to=Document,
         )
 
-    def list(
-        self,
-        *,
-        collection: str,
-        cursor: Optional[str] | NotGiven = NOT_GIVEN,
-        size: 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,
-    ) -> DocumentListResponse:
-        """This endpoint allows you to paginate through all documents in the index.
-
-        You can
-        filter the documents by title, date, metadata, etc.
-
-        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
-        """
-        return self._post(
-            "/documents/list",
-            options=make_request_options(
-                extra_headers=extra_headers,
-                extra_query=extra_query,
-                extra_body=extra_body,
-                timeout=timeout,
-                query=maybe_transform(
-                    {
-                        "collection": collection,
-                        "cursor": cursor,
-                        "size": size,
-                    },
-                    document_list_params.DocumentListParams,
-                ),
-            ),
-            cast_to=DocumentListResponse,
-        )
-
 
 class AsyncDocumentsResource(AsyncAPIResource):
     @cached_property
@@ -176,52 +122,6 @@ async def retrieve(
             cast_to=Document,
         )
 
-    async def list(
-        self,
-        *,
-        collection: str,
-        cursor: Optional[str] | NotGiven = NOT_GIVEN,
-        size: 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,
-    ) -> DocumentListResponse:
-        """This endpoint allows you to paginate through all documents in the index.
-
-        You can
-        filter the documents by title, date, metadata, etc.
-
-        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
-        """
-        return await self._post(
-            "/documents/list",
-            options=make_request_options(
-                extra_headers=extra_headers,
-                extra_query=extra_query,
-                extra_body=extra_body,
-                timeout=timeout,
-                query=await async_maybe_transform(
-                    {
-                        "collection": collection,
-                        "cursor": cursor,
-                        "size": size,
-                    },
-                    document_list_params.DocumentListParams,
-                ),
-            ),
-            cast_to=DocumentListResponse,
-        )
-
 
 class DocumentsResourceWithRawResponse:
     def __init__(self, documents: DocumentsResource) -> None:
@@ -230,9 +130,6 @@ def __init__(self, documents: DocumentsResource) -> None:
         self.retrieve = to_raw_response_wrapper(
             documents.retrieve,
         )
-        self.list = to_raw_response_wrapper(
-            documents.list,
-        )
 
 
 class AsyncDocumentsResourceWithRawResponse:
@@ -242,9 +139,6 @@ def __init__(self, documents: AsyncDocumentsResource) -> None:
         self.retrieve = async_to_raw_response_wrapper(
             documents.retrieve,
         )
-        self.list = async_to_raw_response_wrapper(
-            documents.list,
-        )
 
 
 class DocumentsResourceWithStreamingResponse:
@@ -254,9 +148,6 @@ def __init__(self, documents: DocumentsResource) -> None:
         self.retrieve = to_streamed_response_wrapper(
             documents.retrieve,
         )
-        self.list = to_streamed_response_wrapper(
-            documents.list,
-        )
 
 
 class AsyncDocumentsResourceWithStreamingResponse:
@@ -266,6 +157,3 @@ def __init__(self, documents: AsyncDocumentsResource) -> None:
         self.retrieve = async_to_streamed_response_wrapper(
             documents.retrieve,
         )
-        self.list = async_to_streamed_response_wrapper(
-            documents.list,
-        )

src/hyperspell/types/__init__.py

@@ -3,6 +3,4 @@
 from __future__ import annotations
 
 from .document import Document as Document
-from .document_list_params import DocumentListParams as DocumentListParams
 from .query_retrieve_params import QueryRetrieveParams as QueryRetrieveParams
-from .document_list_response import DocumentListResponse as DocumentListResponse

src/hyperspell/types/document_list_params.py

@@ -9,7 +9,7 @@
 
 from hyperspell import Hyperspell, AsyncHyperspell
 from tests.utils import assert_matches_type
-from hyperspell.types import Document, DocumentListResponse
+from hyperspell.types import Document
 
 base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010")
 
@@ -48,46 +48,6 @@ def test_streaming_response_retrieve(self, client: Hyperspell) -> None:
 
         assert cast(Any, response.is_closed) is True
 
-    @parametrize
-    def test_method_list(self, client: Hyperspell) -> None:
-        document = client.documents.list(
-            collection="collection",
-        )
-        assert_matches_type(DocumentListResponse, document, path=["response"])
-
-    @parametrize
-    def test_method_list_with_all_params(self, client: Hyperspell) -> None:
-        document = client.documents.list(
-            collection="collection",
-            cursor="cursor",
-            size=0,
-        )
-        assert_matches_type(DocumentListResponse, document, path=["response"])
-
-    @parametrize
-    def test_raw_response_list(self, client: Hyperspell) -> None:
-        response = client.documents.with_raw_response.list(
-            collection="collection",
-        )
-
-        assert response.is_closed is True
-        assert response.http_request.headers.get("X-Stainless-Lang") == "python"
-        document = response.parse()
-        assert_matches_type(DocumentListResponse, document, path=["response"])
-
-    @parametrize
-    def test_streaming_response_list(self, client: Hyperspell) -> None:
-        with client.documents.with_streaming_response.list(
-            collection="collection",
-        ) as response:
-            assert not response.is_closed
-            assert response.http_request.headers.get("X-Stainless-Lang") == "python"
-
-            document = response.parse()
-            assert_matches_type(DocumentListResponse, document, path=["response"])
-
-        assert cast(Any, response.is_closed) is True
-
 
 class TestAsyncDocuments:
     parametrize = pytest.mark.parametrize("async_client", [False, True], indirect=True, ids=["loose", "strict"])
@@ -122,43 +82,3 @@ async def test_streaming_response_retrieve(self, async_client: AsyncHyperspell)
             assert_matches_type(Document, document, path=["response"])
 
         assert cast(Any, response.is_closed) is True
-
-    @parametrize
-    async def test_method_list(self, async_client: AsyncHyperspell) -> None:
-        document = await async_client.documents.list(
-            collection="collection",
-        )
-        assert_matches_type(DocumentListResponse, document, path=["response"])
-
-    @parametrize
-    async def test_method_list_with_all_params(self, async_client: AsyncHyperspell) -> None:
-        document = await async_client.documents.list(
-            collection="collection",
-            cursor="cursor",
-            size=0,
-        )
-        assert_matches_type(DocumentListResponse, document, path=["response"])
-
-    @parametrize
-    async def test_raw_response_list(self, async_client: AsyncHyperspell) -> None:
-        response = await async_client.documents.with_raw_response.list(
-            collection="collection",
-        )
-
-        assert response.is_closed is True
-        assert response.http_request.headers.get("X-Stainless-Lang") == "python"
-        document = await response.parse()
-        assert_matches_type(DocumentListResponse, document, path=["response"])
-
-    @parametrize
-    async def test_streaming_response_list(self, async_client: AsyncHyperspell) -> None:
-        async with async_client.documents.with_streaming_response.list(
-            collection="collection",
-        ) as response:
-            assert not response.is_closed
-            assert response.http_request.headers.get("X-Stainless-Lang") == "python"
-
-            document = await response.parse()
-            assert_matches_type(DocumentListResponse, document, path=["response"])
-
-        assert cast(Any, response.is_closed) is True