studyfetch-sdk 0.1.0a17__py3-none-any.whl → 0.1.0a18__py3-none-any.whl

studyfetch_sdk/_version.py

@@ -1,4 +1,4 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 __title__ = "studyfetch_sdk"
-__version__ = "0.1.0-alpha.17"  # x-release-please-version
+__version__ = "0.1.0-alpha.18"  # x-release-please-version

studyfetch_sdk/resources/v1/materials/bulk.py

@@ -2,9 +2,12 @@
 
 from __future__ import annotations
 
+from typing import List, Optional
+
 import httpx
 
-from ...._types import NOT_GIVEN, Body, Query, Headers, NoneType, NotGiven
+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 (
@@ -14,6 +17,8 @@ from ...._response import (
     async_to_streamed_response_wrapper,
 )
 from ...._base_client import make_request_options
+from ....types.v1.materials import bulk_move_params
+from ....types.v1.materials.bulk_move_response import BulkMoveResponse
 
 __all__ = ["BulkResource", "AsyncBulkResource"]
 
@@ -41,20 +46,44 @@ class BulkResource(SyncAPIResource):
     def move(
         self,
         *,
+        folder_id: Optional[str],
+        material_ids: List[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,
-    ) -> None:
-        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+    ) -> BulkMoveResponse:
+        """
+        Bulk move materials to a different folder
+
+        Args:
+          folder_id: Target folder ID (null for root)
+
+          material_ids: Array of material IDs to move
+
+          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(
             "/api/v1/materials/bulk/move",
+            body=maybe_transform(
+                {
+                    "folder_id": folder_id,
+                    "material_ids": material_ids,
+                },
+                bulk_move_params.BulkMoveParams,
+            ),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=NoneType,
+            cast_to=BulkMoveResponse,
         )
 
 
@@ -81,20 +110,44 @@ class AsyncBulkResource(AsyncAPIResource):
     async def move(
         self,
         *,
+        folder_id: Optional[str],
+        material_ids: List[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,
-    ) -> None:
-        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+    ) -> BulkMoveResponse:
+        """
+        Bulk move materials to a different folder
+
+        Args:
+          folder_id: Target folder ID (null for root)
+
+          material_ids: Array of material IDs to move
+
+          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(
             "/api/v1/materials/bulk/move",
+            body=await async_maybe_transform(
+                {
+                    "folder_id": folder_id,
+                    "material_ids": material_ids,
+                },
+                bulk_move_params.BulkMoveParams,
+            ),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=NoneType,
+            cast_to=BulkMoveResponse,
         )
 
 

studyfetch_sdk/resources/v1/materials/materials.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import List
+from typing import List, Iterable, Optional
 
 import httpx
 
@@ -35,8 +35,11 @@ from ...._utils import maybe_transform, async_maybe_transform
 from ...._compat import cached_property
 from ....types.v1 import (
     material_list_params,
+    material_move_params,
     material_create_params,
+    material_rename_params,
     material_search_params,
+    material_batch_create_params,
     material_get_download_url_params,
 )
 from ...._resource import SyncAPIResource, AsyncAPIResource
@@ -49,6 +52,10 @@ from ...._response import (
 from ...._base_client import make_request_options
 from ....types.v1.material import Material
 from ....types.v1.material_list_response import MaterialListResponse
+from ....types.v1.material_debug_response import MaterialDebugResponse
+from ....types.v1.material_search_response import MaterialSearchResponse
+from ....types.v1.material_batch_create_response import MaterialBatchCreateResponse
+from ....types.v1.material_get_download_url_response import MaterialGetDownloadURLResponse
 
 __all__ = ["MaterialsResource", "AsyncMaterialsResource"]
 
@@ -239,20 +246,35 @@ class MaterialsResource(SyncAPIResource):
     def batch_create(
         self,
         *,
+        materials: Iterable[material_batch_create_params.Material],
         # 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,
-    ) -> None:
-        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+    ) -> MaterialBatchCreateResponse:
+        """
+        Create batch upload URLs for multiple materials
+
+        Args:
+          materials: Array of materials to create
+
+          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(
             "/api/v1/materials/batch",
+            body=maybe_transform({"materials": materials}, material_batch_create_params.MaterialBatchCreateParams),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=NoneType,
+            cast_to=MaterialBatchCreateResponse,
         )
 
     def debug(
@@ -265,8 +287,10 @@ class MaterialsResource(SyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> None:
+    ) -> MaterialDebugResponse:
         """
+        Get debug information for a material including extracted content
+
         Args:
           extra_headers: Send extra headers
 
@@ -278,29 +302,32 @@ class MaterialsResource(SyncAPIResource):
         """
         if not id:
             raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
-        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return self._get(
             f"/api/v1/materials/{id}/debug",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=NoneType,
+            cast_to=MaterialDebugResponse,
         )
 
     def get_download_url(
         self,
         id: str,
         *,
-        expires_in: str,
+        expires_in: float | 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,
-    ) -> None:
+    ) -> MaterialGetDownloadURLResponse:
         """
+        Get temporary download URL for material
+
         Args:
+          expires_in: URL expiration time in seconds (default: 3600)
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -311,7 +338,6 @@ class MaterialsResource(SyncAPIResource):
         """
         if not id:
             raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
-        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return self._get(
             f"/api/v1/materials/{id}/download-url",
             options=make_request_options(
@@ -323,22 +349,27 @@ class MaterialsResource(SyncAPIResource):
                     {"expires_in": expires_in}, material_get_download_url_params.MaterialGetDownloadURLParams
                 ),
             ),
-            cast_to=NoneType,
+            cast_to=MaterialGetDownloadURLResponse,
         )
 
     def move(
         self,
         id: str,
         *,
+        folder_id: Optional[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,
-    ) -> None:
+    ) -> Material:
         """
+        Move material to a different folder
+
         Args:
+          folder_id: Target folder ID (null for root)
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -349,28 +380,33 @@ class MaterialsResource(SyncAPIResource):
         """
         if not id:
             raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
-        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return self._post(
             f"/api/v1/materials/{id}/move",
+            body=maybe_transform({"folder_id": folder_id}, material_move_params.MaterialMoveParams),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=NoneType,
+            cast_to=Material,
         )
 
     def rename(
         self,
         id: str,
         *,
+        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,
-    ) -> None:
+    ) -> Material:
         """
+        Rename a material
+
         Args:
+          name: New name for the material
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -381,13 +417,13 @@ class MaterialsResource(SyncAPIResource):
         """
         if not id:
             raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
-        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return self._post(
             f"/api/v1/materials/{id}/rename",
+            body=maybe_transform({"name": name}, material_rename_params.MaterialRenameParams),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=NoneType,
+            cast_to=Material,
         )
 
     def reprocess(
@@ -400,8 +436,10 @@ class MaterialsResource(SyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> None:
+    ) -> Material:
         """
+        Reprocess material to regenerate embeddings and extract content
+
         Args:
           extra_headers: Send extra headers
 
@@ -413,13 +451,12 @@ class MaterialsResource(SyncAPIResource):
         """
         if not id:
             raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
-        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return self._post(
             f"/api/v1/materials/{id}/reprocess",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=NoneType,
+            cast_to=Material,
         )
 
     def search(
@@ -435,19 +472,18 @@ class MaterialsResource(SyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> None:
+    ) -> MaterialSearchResponse:
         """
-        Search materials using RAG
+        Search materials using RAG (Retrieval-Augmented Generation)
 
         Args:
           query: Search query
 
-          folder_ids: Optional: Limit search to materials within specific folders (includes
-              subfolders)
+          folder_ids: Limit search to materials within specific folders (includes subfolders)
 
-          material_ids: Optional: Limit search to specific material IDs
+          material_ids: Limit search to specific material IDs
 
-          top_k: Number of results to return (default: 5)
+          top_k: Number of results to return
 
           extra_headers: Send extra headers
 
@@ -457,7 +493,6 @@ class MaterialsResource(SyncAPIResource):
 
           timeout: Override the client-level default timeout for this request, in seconds
         """
-        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return self._post(
             "/api/v1/materials/search",
             body=maybe_transform(
@@ -472,7 +507,7 @@ class MaterialsResource(SyncAPIResource):
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=NoneType,
+            cast_to=MaterialSearchResponse,
         )
 
 
@@ -662,20 +697,37 @@ class AsyncMaterialsResource(AsyncAPIResource):
     async def batch_create(
         self,
         *,
+        materials: Iterable[material_batch_create_params.Material],
         # 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,
-    ) -> None:
-        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+    ) -> MaterialBatchCreateResponse:
+        """
+        Create batch upload URLs for multiple materials
+
+        Args:
+          materials: Array of materials to create
+
+          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(
             "/api/v1/materials/batch",
+            body=await async_maybe_transform(
+                {"materials": materials}, material_batch_create_params.MaterialBatchCreateParams
+            ),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=NoneType,
+            cast_to=MaterialBatchCreateResponse,
         )
 
     async def debug(
@@ -688,8 +740,10 @@ class AsyncMaterialsResource(AsyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> None:
+    ) -> MaterialDebugResponse:
         """
+        Get debug information for a material including extracted content
+
         Args:
           extra_headers: Send extra headers
 
@@ -701,29 +755,32 @@ class AsyncMaterialsResource(AsyncAPIResource):
         """
         if not id:
             raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
-        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return await self._get(
             f"/api/v1/materials/{id}/debug",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=NoneType,
+            cast_to=MaterialDebugResponse,
         )
 
     async def get_download_url(
         self,
         id: str,
         *,
-        expires_in: str,
+        expires_in: float | 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,
-    ) -> None:
+    ) -> MaterialGetDownloadURLResponse:
         """
+        Get temporary download URL for material
+
         Args:
+          expires_in: URL expiration time in seconds (default: 3600)
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -734,7 +791,6 @@ class AsyncMaterialsResource(AsyncAPIResource):
         """
         if not id:
             raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
-        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return await self._get(
             f"/api/v1/materials/{id}/download-url",
             options=make_request_options(
@@ -746,22 +802,27 @@ class AsyncMaterialsResource(AsyncAPIResource):
                     {"expires_in": expires_in}, material_get_download_url_params.MaterialGetDownloadURLParams
                 ),
             ),
-            cast_to=NoneType,
+            cast_to=MaterialGetDownloadURLResponse,
         )
 
     async def move(
         self,
         id: str,
         *,
+        folder_id: Optional[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,
-    ) -> None:
+    ) -> Material:
         """
+        Move material to a different folder
+
         Args:
+          folder_id: Target folder ID (null for root)
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -772,28 +833,33 @@ class AsyncMaterialsResource(AsyncAPIResource):
         """
         if not id:
             raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
-        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return await self._post(
             f"/api/v1/materials/{id}/move",
+            body=await async_maybe_transform({"folder_id": folder_id}, material_move_params.MaterialMoveParams),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=NoneType,
+            cast_to=Material,
         )
 
     async def rename(
         self,
         id: str,
         *,
+        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,
-    ) -> None:
+    ) -> Material:
         """
+        Rename a material
+
         Args:
+          name: New name for the material
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -804,13 +870,13 @@ class AsyncMaterialsResource(AsyncAPIResource):
         """
         if not id:
             raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
-        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return await self._post(
             f"/api/v1/materials/{id}/rename",
+            body=await async_maybe_transform({"name": name}, material_rename_params.MaterialRenameParams),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=NoneType,
+            cast_to=Material,
         )
 
     async def reprocess(
@@ -823,8 +889,10 @@ class AsyncMaterialsResource(AsyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> None:
+    ) -> Material:
         """
+        Reprocess material to regenerate embeddings and extract content
+
         Args:
           extra_headers: Send extra headers
 
@@ -836,13 +904,12 @@ class AsyncMaterialsResource(AsyncAPIResource):
         """
         if not id:
             raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
-        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return await self._post(
             f"/api/v1/materials/{id}/reprocess",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=NoneType,
+            cast_to=Material,
         )
 
     async def search(
@@ -858,19 +925,18 @@ class AsyncMaterialsResource(AsyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> None:
+    ) -> MaterialSearchResponse:
         """
-        Search materials using RAG
+        Search materials using RAG (Retrieval-Augmented Generation)
 
         Args:
           query: Search query
 
-          folder_ids: Optional: Limit search to materials within specific folders (includes
-              subfolders)
+          folder_ids: Limit search to materials within specific folders (includes subfolders)
 
-          material_ids: Optional: Limit search to specific material IDs
+          material_ids: Limit search to specific material IDs
 
-          top_k: Number of results to return (default: 5)
+          top_k: Number of results to return
 
           extra_headers: Send extra headers
 
@@ -880,7 +946,6 @@ class AsyncMaterialsResource(AsyncAPIResource):
 
           timeout: Override the client-level default timeout for this request, in seconds
         """
-        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return await self._post(
             "/api/v1/materials/search",
             body=await async_maybe_transform(
@@ -895,7 +960,7 @@ class AsyncMaterialsResource(AsyncAPIResource):
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=NoneType,
+            cast_to=MaterialSearchResponse,
         )