feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 14
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/hyperspell%2Fhyperspell-41cc2c9708dd44636519f09907b8945c8d7a8c0d2f9586f4ff6b54dc87529afd.yml
-openapi_spec_hash: 13e20d1a1759b5a513d2441732a0851e
+configured_endpoints: 10
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/hyperspell%2Fhyperspell-3798b2043988c1dba908d62df73c76dc771f2cda8a401ca34960c3303cfceaa2.yml
+openapi_spec_hash: 1b2e464ea074f544ccd927283c992cef
 config_hash: a39dfe90372d06d735dfb3d27b30409f

README.md

@@ -143,7 +143,7 @@ first_page = await client.documents.list(
 
 print(f"next page cursor: {first_page.next_cursor}")  # => "next page cursor: ..."
 for document in first_page.items:
-    print(document.id)
+    print(document.resource_id)
 
 # Remove `await` for non-async usage.
 ```
@@ -165,7 +165,7 @@ response = client.query.search(
         "after": datetime.fromisoformat("2019-12-27T18:11:19.117"),
         "before": datetime.fromisoformat("2019-12-27T18:11:19.117"),
         "box": {},
-        "collections": {"collections": ["string"]},
+        "collections": {},
         "google_calendar": {"calendar_id": "calendar_id"},
         "google_drive": {},
         "notion": {"notion_page_ids": ["string"]},
@@ -195,7 +195,6 @@ from hyperspell import Hyperspell
 client = Hyperspell()
 
 client.documents.upload(
-    collection="collection",
     file=Path("/path/to/file"),
 )
 ```

api.md

@@ -39,30 +39,26 @@ Methods:
 Types:
 
 ```python
-from hyperspell.types import Document, DocumentStatus, DocumentListResponse, DocumentGetResponse
+from hyperspell.types import DocumentStatus, DocumentListResponse
 ```
 
 Methods:
 
 - <code title="get /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">SyncCursorPage[DocumentListResponse]</a></code>
 - <code title="post /documents/add">client.documents.<a href="./src/hyperspell/resources/documents.py">add</a>(\*\*<a href="src/hyperspell/types/document_add_params.py">params</a>) -> <a href="./src/hyperspell/types/document_status.py">DocumentStatus</a></code>
-- <code title="post /documents/scrape">client.documents.<a href="./src/hyperspell/resources/documents.py">add_url</a>(\*\*<a href="src/hyperspell/types/document_add_url_params.py">params</a>) -> <a href="./src/hyperspell/types/document_status.py">DocumentStatus</a></code>
-- <code title="get /documents/get/{document_id}">client.documents.<a href="./src/hyperspell/resources/documents.py">get</a>(document_id) -> <a href="./src/hyperspell/types/document_get_response.py">object</a></code>
 - <code title="post /documents/upload">client.documents.<a href="./src/hyperspell/resources/documents.py">upload</a>(\*\*<a href="src/hyperspell/types/document_upload_params.py">params</a>) -> <a href="./src/hyperspell/types/document_status.py">DocumentStatus</a></code>
 
 # Collections
 
 Types:
 
 ```python
-from hyperspell.types import Collection, CollectionListResponse
+from hyperspell.types import CollectionListResponse
 ```
 
 Methods:
 
-- <code title="post /collections/add">client.collections.<a href="./src/hyperspell/resources/collections.py">create</a>(\*\*<a href="src/hyperspell/types/collection_create_params.py">params</a>) -> <a href="./src/hyperspell/types/collection.py">Collection</a></code>
 - <code title="get /collections/list">client.collections.<a href="./src/hyperspell/resources/collections.py">list</a>(\*\*<a href="src/hyperspell/types/collection_list_params.py">params</a>) -> <a href="./src/hyperspell/types/collection_list_response.py">SyncCursorPage[CollectionListResponse]</a></code>
-- <code title="get /collections/get/{name}">client.collections.<a href="./src/hyperspell/resources/collections.py">get</a>(name) -> <a href="./src/hyperspell/types/collection.py">Collection</a></code>
 
 # Query
 

src/hyperspell/resources/auth.py

@@ -72,7 +72,7 @@ def user_token(
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> Token:
-        """Use this endpoing to create a user token for a specific user.
+        """Use this endpoint to create a user token for a specific user.
 
         This token can be
         safely passed to your user-facing front-end.
@@ -146,7 +146,7 @@ async def user_token(
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> Token:
-        """Use this endpoing to create a user token for a specific user.
+        """Use this endpoint to create a user token for a specific user.
 
         This token can be
         safely passed to your user-facing front-end.

src/hyperspell/resources/collections.py

@@ -6,9 +6,9 @@
 
 import httpx
 
-from ..types import collection_list_params, collection_create_params
+from ..types import collection_list_params
 from .._types import NOT_GIVEN, Body, Query, Headers, NotGiven
-from .._utils import maybe_transform, async_maybe_transform
+from .._utils import maybe_transform
 from .._compat import cached_property
 from .._resource import SyncAPIResource, AsyncAPIResource
 from .._response import (
@@ -19,7 +19,6 @@
 )
 from ..pagination import SyncCursorPage, AsyncCursorPage
 from .._base_client import AsyncPaginator, make_request_options
-from ..types.collection import Collection
 from ..types.collection_list_response import CollectionListResponse
 
 __all__ = ["CollectionsResource", "AsyncCollectionsResource"]
@@ -45,52 +44,6 @@ def with_streaming_response(self) -> CollectionsResourceWithStreamingResponse:
         """
         return CollectionsResourceWithStreamingResponse(self)
 
-    def create(
-        self,
-        *,
-        name: str,
-        owner: Optional[str] | 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,
-    ) -> Collection:
-        """This endpoint allows you to paginate through all documents in the index.
-
-        You can
-        filter the documents by title, date, metadata, etc.
-
-        Args:
-          name: The name of the collection.
-
-          owner: The owner of the collection. If the request is made using a user token, this
-              will be set to the user ID.
-
-          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(
-            "/collections/add",
-            body=maybe_transform(
-                {
-                    "name": name,
-                    "owner": owner,
-                },
-                collection_create_params.CollectionCreateParams,
-            ),
-            options=make_request_options(
-                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
-            ),
-            cast_to=Collection,
-        )
-
     def list(
         self,
         *,
@@ -103,8 +56,10 @@ def list(
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> SyncCursorPage[CollectionListResponse]:
-        """
-        Lists all collections the user has access to.
+        """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
@@ -134,39 +89,6 @@ def list(
             model=CollectionListResponse,
         )
 
-    def get(
-        self,
-        name: str,
-        *,
-        # 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,
-    ) -> Collection:
-        """
-        Retrieves a collection by name.
-
-        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
-        """
-        if not name:
-            raise ValueError(f"Expected a non-empty value for `name` but received {name!r}")
-        return self._get(
-            f"/collections/get/{name}",
-            options=make_request_options(
-                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
-            ),
-            cast_to=Collection,
-        )
-
 
 class AsyncCollectionsResource(AsyncAPIResource):
     @cached_property
@@ -188,52 +110,6 @@ def with_streaming_response(self) -> AsyncCollectionsResourceWithStreamingRespon
         """
         return AsyncCollectionsResourceWithStreamingResponse(self)
 
-    async def create(
-        self,
-        *,
-        name: str,
-        owner: Optional[str] | 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,
-    ) -> Collection:
-        """This endpoint allows you to paginate through all documents in the index.
-
-        You can
-        filter the documents by title, date, metadata, etc.
-
-        Args:
-          name: The name of the collection.
-
-          owner: The owner of the collection. If the request is made using a user token, this
-              will be set to the user ID.
-
-          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(
-            "/collections/add",
-            body=await async_maybe_transform(
-                {
-                    "name": name,
-                    "owner": owner,
-                },
-                collection_create_params.CollectionCreateParams,
-            ),
-            options=make_request_options(
-                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
-            ),
-            cast_to=Collection,
-        )
-
     def list(
         self,
         *,
@@ -246,8 +122,10 @@ def list(
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> AsyncPaginator[CollectionListResponse, AsyncCursorPage[CollectionListResponse]]:
-        """
-        Lists all collections the user has access to.
+        """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
@@ -277,95 +155,38 @@ def list(
             model=CollectionListResponse,
         )
 
-    async def get(
-        self,
-        name: str,
-        *,
-        # 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,
-    ) -> Collection:
-        """
-        Retrieves a collection by name.
-
-        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
-        """
-        if not name:
-            raise ValueError(f"Expected a non-empty value for `name` but received {name!r}")
-        return await self._get(
-            f"/collections/get/{name}",
-            options=make_request_options(
-                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
-            ),
-            cast_to=Collection,
-        )
-
 
 class CollectionsResourceWithRawResponse:
     def __init__(self, collections: CollectionsResource) -> None:
         self._collections = collections
 
-        self.create = to_raw_response_wrapper(
-            collections.create,
-        )
         self.list = to_raw_response_wrapper(
             collections.list,
         )
-        self.get = to_raw_response_wrapper(
-            collections.get,
-        )
 
 
 class AsyncCollectionsResourceWithRawResponse:
     def __init__(self, collections: AsyncCollectionsResource) -> None:
         self._collections = collections
 
-        self.create = async_to_raw_response_wrapper(
-            collections.create,
-        )
         self.list = async_to_raw_response_wrapper(
             collections.list,
         )
-        self.get = async_to_raw_response_wrapper(
-            collections.get,
-        )
 
 
 class CollectionsResourceWithStreamingResponse:
     def __init__(self, collections: CollectionsResource) -> None:
         self._collections = collections
 
-        self.create = to_streamed_response_wrapper(
-            collections.create,
-        )
         self.list = to_streamed_response_wrapper(
             collections.list,
         )
-        self.get = to_streamed_response_wrapper(
-            collections.get,
-        )
 
 
 class AsyncCollectionsResourceWithStreamingResponse:
     def __init__(self, collections: AsyncCollectionsResource) -> None:
         self._collections = collections
 
-        self.create = async_to_streamed_response_wrapper(
-            collections.create,
-        )
         self.list = async_to_streamed_response_wrapper(
             collections.list,
         )
-        self.get = async_to_streamed_response_wrapper(
-            collections.get,
-        )