feat(api): manual updates

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 16
+configured_endpoints: 17
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/supermemory--inc%2Fsupermemory-new-d52acd1a525b4bfe9f4befcc3a645f5d1289d75e7bad999cf1330e539b2ed84e.yml
 openapi_spec_hash: c34df5406cfa4d245812d30f99d28116
-config_hash: be10c837d5319a33f30809a3ec223caf
+config_hash: 38ef57207cda6bd69b47a02098e2fdb0

README.md

@@ -111,6 +111,23 @@ Nested request parameters are [TypedDicts](https://docs.python.org/3/library/typ
 
 Typed requests and responses provide autocomplete and documentation within your editor. If you would like to see type errors in VS Code to help catch bugs earlier, set `python.analysis.typeCheckingMode` to `basic`.
 
+## File uploads
+
+Request parameters that correspond to file uploads can be passed as `bytes`, or a [`PathLike`](https://docs.python.org/3/library/os.html#os.PathLike) instance or a tuple of `(filename, contents, media type)`.
+
+```python
+from pathlib import Path
+from supermemory import Supermemory
+
+client = Supermemory()
+
+client.memories.upload_file(
+    file=Path("/path/to/file"),
+)
+```
+
+The async client uses the exact same interface. If you pass a [`PathLike`](https://docs.python.org/3/library/os.html#os.PathLike) instance, the file contents will be read asynchronously automatically.
+
 ## Handling errors
 
 When the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of `supermemory.APIConnectionError` is raised.

api.md

@@ -8,6 +8,7 @@ from supermemory.types import (
     MemoryListResponse,
     MemoryAddResponse,
     MemoryGetResponse,
+    MemoryUploadFileResponse,
 )
 ```
 
@@ -18,6 +19,7 @@ Methods:
 - <code title="delete /v3/memories/{id}">client.memories.<a href="./src/supermemory/resources/memories.py">delete</a>(id) -> None</code>
 - <code title="post /v3/memories">client.memories.<a href="./src/supermemory/resources/memories.py">add</a>(\*\*<a href="src/supermemory/types/memory_add_params.py">params</a>) -> <a href="./src/supermemory/types/memory_add_response.py">MemoryAddResponse</a></code>
 - <code title="get /v3/memories/{id}">client.memories.<a href="./src/supermemory/resources/memories.py">get</a>(id) -> <a href="./src/supermemory/types/memory_get_response.py">MemoryGetResponse</a></code>
+- <code title="post /v3/memories/file">client.memories.<a href="./src/supermemory/resources/memories.py">upload_file</a>(\*\*<a href="src/supermemory/types/memory_upload_file_params.py">params</a>) -> <a href="./src/supermemory/types/memory_upload_file_response.py">MemoryUploadFileResponse</a></code>
 
 # Search
 

src/supermemory/_files.py

@@ -34,7 +34,7 @@ def assert_is_file_content(obj: object, *, key: str | None = None) -> None:
     if not is_file_content(obj):
         prefix = f"Expected entry at `{key}`" if key is not None else f"Expected file input `{obj!r}`"
         raise RuntimeError(
-            f"{prefix} to be bytes, an io.IOBase instance, PathLike or a tuple but received {type(obj)} instead."
+            f"{prefix} to be bytes, an io.IOBase instance, PathLike or a tuple but received {type(obj)} instead. See https://github.com/supermemoryai/python-sdk/tree/main#file-uploads"
         ) from None
 
 

src/supermemory/resources/memories.py

@@ -2,14 +2,14 @@
 
 from __future__ import annotations
 
-from typing import Dict, List, Union
+from typing import Dict, List, Union, Mapping, cast
 from typing_extensions import Literal
 
 import httpx
 
-from ..types import memory_add_params, memory_list_params, memory_update_params
-from .._types import NOT_GIVEN, Body, Query, Headers, NoneType, NotGiven
-from .._utils import maybe_transform, async_maybe_transform
+from ..types import memory_add_params, memory_list_params, memory_update_params, memory_upload_file_params
+from .._types import NOT_GIVEN, Body, Query, Headers, NoneType, NotGiven, FileTypes
+from .._utils import extract_files, maybe_transform, deepcopy_minimal, async_maybe_transform
 from .._compat import cached_property
 from .._resource import SyncAPIResource, AsyncAPIResource
 from .._response import (
@@ -23,6 +23,7 @@
 from ..types.memory_get_response import MemoryGetResponse
 from ..types.memory_list_response import MemoryListResponse
 from ..types.memory_update_response import MemoryUpdateResponse
+from ..types.memory_upload_file_response import MemoryUploadFileResponse
 
 __all__ = ["MemoriesResource", "AsyncMemoriesResource"]
 
@@ -305,6 +306,51 @@ def get(
             cast_to=MemoryGetResponse,
         )
 
+    def upload_file(
+        self,
+        *,
+        file: FileTypes,
+        container_tags: 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,
+    ) -> MemoryUploadFileResponse:
+        """
+        Upload a file to be processed
+
+        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
+        """
+        body = deepcopy_minimal(
+            {
+                "file": file,
+                "container_tags": container_tags,
+            }
+        )
+        files = extract_files(cast(Mapping[str, object], body), paths=[["file"]])
+        # It should be noted that the actual Content-Type header that will be
+        # sent to the server will contain a `boundary` parameter, e.g.
+        # multipart/form-data; boundary=---abc--
+        extra_headers = {"Content-Type": "multipart/form-data", **(extra_headers or {})}
+        return self._post(
+            "/v3/memories/file",
+            body=maybe_transform(body, memory_upload_file_params.MemoryUploadFileParams),
+            files=files,
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=MemoryUploadFileResponse,
+        )
+
 
 class AsyncMemoriesResource(AsyncAPIResource):
     @cached_property
@@ -584,6 +630,51 @@ async def get(
             cast_to=MemoryGetResponse,
         )
 
+    async def upload_file(
+        self,
+        *,
+        file: FileTypes,
+        container_tags: 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,
+    ) -> MemoryUploadFileResponse:
+        """
+        Upload a file to be processed
+
+        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
+        """
+        body = deepcopy_minimal(
+            {
+                "file": file,
+                "container_tags": container_tags,
+            }
+        )
+        files = extract_files(cast(Mapping[str, object], body), paths=[["file"]])
+        # It should be noted that the actual Content-Type header that will be
+        # sent to the server will contain a `boundary` parameter, e.g.
+        # multipart/form-data; boundary=---abc--
+        extra_headers = {"Content-Type": "multipart/form-data", **(extra_headers or {})}
+        return await self._post(
+            "/v3/memories/file",
+            body=await async_maybe_transform(body, memory_upload_file_params.MemoryUploadFileParams),
+            files=files,
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=MemoryUploadFileResponse,
+        )
+
 
 class MemoriesResourceWithRawResponse:
     def __init__(self, memories: MemoriesResource) -> None:
@@ -604,6 +695,9 @@ def __init__(self, memories: MemoriesResource) -> None:
         self.get = to_raw_response_wrapper(
             memories.get,
         )
+        self.upload_file = to_raw_response_wrapper(
+            memories.upload_file,
+        )
 
 
 class AsyncMemoriesResourceWithRawResponse:
@@ -625,6 +719,9 @@ def __init__(self, memories: AsyncMemoriesResource) -> None:
         self.get = async_to_raw_response_wrapper(
             memories.get,
         )
+        self.upload_file = async_to_raw_response_wrapper(
+            memories.upload_file,
+        )
 
 
 class MemoriesResourceWithStreamingResponse:
@@ -646,6 +743,9 @@ def __init__(self, memories: MemoriesResource) -> None:
         self.get = to_streamed_response_wrapper(
             memories.get,
         )
+        self.upload_file = to_streamed_response_wrapper(
+            memories.upload_file,
+        )
 
 
 class AsyncMemoriesResourceWithStreamingResponse:
@@ -667,3 +767,6 @@ def __init__(self, memories: AsyncMemoriesResource) -> None:
         self.get = async_to_streamed_response_wrapper(
             memories.get,
         )
+        self.upload_file = async_to_streamed_response_wrapper(
+            memories.upload_file,
+        )

src/supermemory/types/__init__.py

@@ -18,7 +18,9 @@
 from .connection_create_params import ConnectionCreateParams as ConnectionCreateParams
 from .connection_import_params import ConnectionImportParams as ConnectionImportParams
 from .connection_list_response import ConnectionListResponse as ConnectionListResponse
+from .memory_upload_file_params import MemoryUploadFileParams as MemoryUploadFileParams
 from .connection_create_response import ConnectionCreateResponse as ConnectionCreateResponse
+from .memory_upload_file_response import MemoryUploadFileResponse as MemoryUploadFileResponse
 from .connection_get_by_id_response import ConnectionGetByIDResponse as ConnectionGetByIDResponse
 from .connection_get_by_tags_params import ConnectionGetByTagsParams as ConnectionGetByTagsParams
 from .connection_get_by_tags_response import ConnectionGetByTagsResponse as ConnectionGetByTagsResponse

src/supermemory/types/memory_upload_file_params.py

@@ -0,0 +1,16 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, Annotated, TypedDict
+
+from .._types import FileTypes
+from .._utils import PropertyInfo
+
+__all__ = ["MemoryUploadFileParams"]
+
+
+class MemoryUploadFileParams(TypedDict, total=False):
+    file: Required[FileTypes]
+
+    container_tags: Annotated[str, PropertyInfo(alias="containerTags")]

src/supermemory/types/memory_upload_file_response.py

@@ -0,0 +1,11 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from .._models import BaseModel
+
+__all__ = ["MemoryUploadFileResponse"]
+
+
+class MemoryUploadFileResponse(BaseModel):
+    id: str
+
+    status: str

tests/api_resources/test_memories.py

@@ -14,6 +14,7 @@
     MemoryGetResponse,
     MemoryListResponse,
     MemoryUpdateResponse,
+    MemoryUploadFileResponse,
 )
 
 base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010")
@@ -254,6 +255,49 @@ def test_path_params_get(self, client: Supermemory) -> None:
                 "",
             )
 
+    @pytest.mark.skip(reason="Prism tests are disabled")
+    @parametrize
+    def test_method_upload_file(self, client: Supermemory) -> None:
+        memory = client.memories.upload_file(
+            file=b"raw file contents",
+        )
+        assert_matches_type(MemoryUploadFileResponse, memory, path=["response"])
+
+    @pytest.mark.skip(reason="Prism tests are disabled")
+    @parametrize
+    def test_method_upload_file_with_all_params(self, client: Supermemory) -> None:
+        memory = client.memories.upload_file(
+            file=b"raw file contents",
+            container_tags="containerTags",
+        )
+        assert_matches_type(MemoryUploadFileResponse, memory, path=["response"])
+
+    @pytest.mark.skip(reason="Prism tests are disabled")
+    @parametrize
+    def test_raw_response_upload_file(self, client: Supermemory) -> None:
+        response = client.memories.with_raw_response.upload_file(
+            file=b"raw file contents",
+        )
+
+        assert response.is_closed is True
+        assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+        memory = response.parse()
+        assert_matches_type(MemoryUploadFileResponse, memory, path=["response"])
+
+    @pytest.mark.skip(reason="Prism tests are disabled")
+    @parametrize
+    def test_streaming_response_upload_file(self, client: Supermemory) -> None:
+        with client.memories.with_streaming_response.upload_file(
+            file=b"raw file contents",
+        ) as response:
+            assert not response.is_closed
+            assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+
+            memory = response.parse()
+            assert_matches_type(MemoryUploadFileResponse, memory, path=["response"])
+
+        assert cast(Any, response.is_closed) is True
+
 
 class TestAsyncMemories:
     parametrize = pytest.mark.parametrize(
@@ -491,3 +535,46 @@ async def test_path_params_get(self, async_client: AsyncSupermemory) -> None:
             await async_client.memories.with_raw_response.get(
                 "",
             )
+
+    @pytest.mark.skip(reason="Prism tests are disabled")
+    @parametrize
+    async def test_method_upload_file(self, async_client: AsyncSupermemory) -> None:
+        memory = await async_client.memories.upload_file(
+            file=b"raw file contents",
+        )
+        assert_matches_type(MemoryUploadFileResponse, memory, path=["response"])
+
+    @pytest.mark.skip(reason="Prism tests are disabled")
+    @parametrize
+    async def test_method_upload_file_with_all_params(self, async_client: AsyncSupermemory) -> None:
+        memory = await async_client.memories.upload_file(
+            file=b"raw file contents",
+            container_tags="containerTags",
+        )
+        assert_matches_type(MemoryUploadFileResponse, memory, path=["response"])
+
+    @pytest.mark.skip(reason="Prism tests are disabled")
+    @parametrize
+    async def test_raw_response_upload_file(self, async_client: AsyncSupermemory) -> None:
+        response = await async_client.memories.with_raw_response.upload_file(
+            file=b"raw file contents",
+        )
+
+        assert response.is_closed is True
+        assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+        memory = await response.parse()
+        assert_matches_type(MemoryUploadFileResponse, memory, path=["response"])
+
+    @pytest.mark.skip(reason="Prism tests are disabled")
+    @parametrize
+    async def test_streaming_response_upload_file(self, async_client: AsyncSupermemory) -> None:
+        async with async_client.memories.with_streaming_response.upload_file(
+            file=b"raw file contents",
+        ) as response:
+            assert not response.is_closed
+            assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+
+            memory = await response.parse()
+            assert_matches_type(MemoryUploadFileResponse, memory, path=["response"])
+
+        assert cast(Any, response.is_closed) is True