feat(api): api update (#44)

Author: stainless-app[bot]

.stats.yml

@@ -1,2 +1,2 @@
 configured_endpoints: 10
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/hyperspell%2Fhyperspell-ba6c4db7ea12bd505fe5cfe650ef7372c17dbe083875afea40d5de959dbba9e1.yml
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/hyperspell%2Fhyperspell-e2730102bf18b9b31baab9d5f3a0545acdcaec16f74b2b64831c5a99230ab847.yml

src/hyperspell/resources/query.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import List
+from typing import List, Union
 from typing_extensions import Literal
 
 import httpx
@@ -50,8 +50,8 @@ def with_streaming_response(self) -> QueryResourceWithStreamingResponse:
     def search(
         self,
         *,
+        collections: Union[str, List[str]],
         query: str,
-        collections: List[str] | NotGiven = NOT_GIVEN,
         filter: query_search_params.Filter | NotGiven = NOT_GIVEN,
         include_elements: bool | NotGiven = NOT_GIVEN,
         max_results: int | NotGiven = NOT_GIVEN,
@@ -67,10 +67,10 @@ def search(
         Retrieves documents matching the query.
 
         Args:
-          query: Query to run.
-
           collections: Only query documents in these collections.
 
+          query: Query to run.
+
           filter: Filter the query results.
 
           include_elements: Include the elements of a section in the results.
@@ -91,8 +91,8 @@ def search(
             "/query",
             body=maybe_transform(
                 {
-                    "query": query,
                     "collections": collections,
+                    "query": query,
                     "filter": filter,
                     "include_elements": include_elements,
                     "max_results": max_results,
@@ -130,8 +130,8 @@ def with_streaming_response(self) -> AsyncQueryResourceWithStreamingResponse:
     async def search(
         self,
         *,
+        collections: Union[str, List[str]],
         query: str,
-        collections: List[str] | NotGiven = NOT_GIVEN,
         filter: query_search_params.Filter | NotGiven = NOT_GIVEN,
         include_elements: bool | NotGiven = NOT_GIVEN,
         max_results: int | NotGiven = NOT_GIVEN,
@@ -147,10 +147,10 @@ async def search(
         Retrieves documents matching the query.
 
         Args:
-          query: Query to run.
-
           collections: Only query documents in these collections.
 
+          query: Query to run.
+
           filter: Filter the query results.
 
           include_elements: Include the elements of a section in the results.
@@ -171,8 +171,8 @@ async def search(
             "/query",
             body=await async_maybe_transform(
                 {
-                    "query": query,
                     "collections": collections,
+                    "query": query,
                     "filter": filter,
                     "include_elements": include_elements,
                     "max_results": max_results,

src/hyperspell/types/query_search_params.py

@@ -12,12 +12,12 @@
 
 
 class QuerySearchParams(TypedDict, total=False):
+    collections: Required[Union[str, List[str]]]
+    """Only query documents in these collections."""
+
     query: Required[str]
     """Query to run."""
 
-    collections: List[str]
-    """Only query documents in these collections."""
-
     filter: Filter
     """Filter the query results."""
 

tests/api_resources/test_query.py

@@ -21,15 +21,16 @@ class TestQuery:
     @parametrize
     def test_method_search(self, client: Hyperspell) -> None:
         query = client.query.search(
+            collections="string",
             query="query",
         )
         assert_matches_type(QuerySearchResponse, query, path=["response"])
 
     @parametrize
     def test_method_search_with_all_params(self, client: Hyperspell) -> None:
         query = client.query.search(
+            collections="string",
             query="query",
-            collections=["string"],
             filter={
                 "end_date": parse_datetime("2019-12-27T18:11:19.117Z"),
                 "source": ["generic"],
@@ -44,6 +45,7 @@ def test_method_search_with_all_params(self, client: Hyperspell) -> None:
     @parametrize
     def test_raw_response_search(self, client: Hyperspell) -> None:
         response = client.query.with_raw_response.search(
+            collections="string",
             query="query",
         )
 
@@ -55,6 +57,7 @@ def test_raw_response_search(self, client: Hyperspell) -> None:
     @parametrize
     def test_streaming_response_search(self, client: Hyperspell) -> None:
         with client.query.with_streaming_response.search(
+            collections="string",
             query="query",
         ) as response:
             assert not response.is_closed
@@ -72,15 +75,16 @@ class TestAsyncQuery:
     @parametrize
     async def test_method_search(self, async_client: AsyncHyperspell) -> None:
         query = await async_client.query.search(
+            collections="string",
             query="query",
         )
         assert_matches_type(QuerySearchResponse, query, path=["response"])
 
     @parametrize
     async def test_method_search_with_all_params(self, async_client: AsyncHyperspell) -> None:
         query = await async_client.query.search(
+            collections="string",
             query="query",
-            collections=["string"],
             filter={
                 "end_date": parse_datetime("2019-12-27T18:11:19.117Z"),
                 "source": ["generic"],
@@ -95,6 +99,7 @@ async def test_method_search_with_all_params(self, async_client: AsyncHyperspell
     @parametrize
     async def test_raw_response_search(self, async_client: AsyncHyperspell) -> None:
         response = await async_client.query.with_raw_response.search(
+            collections="string",
             query="query",
         )
 
@@ -106,6 +111,7 @@ async def test_raw_response_search(self, async_client: AsyncHyperspell) -> None:
     @parametrize
     async def test_streaming_response_search(self, async_client: AsyncHyperspell) -> None:
         async with async_client.query.with_streaming_response.search(
+            collections="string",
             query="query",
         ) as response:
             assert not response.is_closed