studyfetch-sdk 0.1.0a8__tar.gz → 0.1.0a9__tar.gz

studyfetch_sdk-0.1.0a9/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "0.1.0-alpha.9"
+}

{studyfetch_sdk-0.1.0a8 → studyfetch_sdk-0.1.0a9}/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 0.1.0-alpha.9 (2025-07-20)
+
+Full Changelog: [v0.1.0-alpha.8...v0.1.0-alpha.9](https://github.com/GoStudyFetchGo/studyfetch-sdk-python/compare/v0.1.0-alpha.8...v0.1.0-alpha.9)
+
+### Features
+
+* **api:** api update ([adcb732](https://github.com/GoStudyFetchGo/studyfetch-sdk-python/commit/adcb7325f9e331c70f4ba71de059939e03cadf78))
+* **api:** manual updates ([408618b](https://github.com/GoStudyFetchGo/studyfetch-sdk-python/commit/408618bebe1563c23e1470cc83973cf7008a5806))
+
 ## 0.1.0-alpha.8 (2025-07-20)
 
 Full Changelog: [v0.1.0-alpha.7...v0.1.0-alpha.8](https://github.com/GoStudyFetchGo/studyfetch-sdk-python/compare/v0.1.0-alpha.7...v0.1.0-alpha.8)

{studyfetch_sdk-0.1.0a8 → studyfetch_sdk-0.1.0a9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: studyfetch_sdk
-Version: 0.1.0a8
+Version: 0.1.0a9
 Summary: The official Python library for the studyfetch-sdk API
 Project-URL: Homepage, https://github.com/GoStudyFetchGo/studyfetch-sdk-python
 Project-URL: Repository, https://github.com/GoStudyFetchGo/studyfetch-sdk-python
@@ -67,7 +67,13 @@ client = StudyfetchSDK(
     api_key=os.environ.get("STUDYFETCH_SDK_API_KEY"),  # This is the default and can be omitted
 )
 
-materials = client.v1.materials.list()
+component = client.v1.components.create(
+    config={"model": "gpt-4o-mini-2024-07-18"},
+    name="My Study Component",
+    origin="api",
+    type="flashcards",
+)
+print(component._id)
 ```
 
 While you can provide an `api_key` keyword argument,
@@ -90,7 +96,13 @@ client = AsyncStudyfetchSDK(
 
 
 async def main() -> None:
-    materials = await client.v1.materials.list()
+    component = await client.v1.components.create(
+        config={"model": "gpt-4o-mini-2024-07-18"},
+        name="My Study Component",
+        origin="api",
+        type="flashcards",
+    )
+    print(component._id)
 
 
 asyncio.run(main())
@@ -122,7 +134,13 @@ async def main() -> None:
         api_key="My API Key",
         http_client=DefaultAioHttpClient(),
     ) as client:
-        materials = await client.v1.materials.list()
+        component = await client.v1.components.create(
+            config={"model": "gpt-4o-mini-2024-07-18"},
+            name="My Study Component",
+            origin="api",
+            type="flashcards",
+        )
+        print(component._id)
 
 
 asyncio.run(main())
@@ -187,7 +205,12 @@ from studyfetch_sdk import StudyfetchSDK
 client = StudyfetchSDK()
 
 try:
-    client.v1.materials.list()
+    client.v1.components.create(
+        config={"model": "gpt-4o-mini-2024-07-18"},
+        name="My Study Component",
+        origin="api",
+        type="flashcards",
+    )
 except studyfetch_sdk.APIConnectionError as e:
     print("The server could not be reached")
     print(e.__cause__)  # an underlying Exception, likely raised within httpx.
@@ -230,7 +253,12 @@ client = StudyfetchSDK(
 )
 
 # Or, configure per-request:
-client.with_options(max_retries=5).v1.materials.list()
+client.with_options(max_retries=5).v1.components.create(
+    config={"model": "gpt-4o-mini-2024-07-18"},
+    name="My Study Component",
+    origin="api",
+    type="flashcards",
+)
 ```
 
 ### Timeouts
@@ -253,7 +281,12 @@ client = StudyfetchSDK(
 )
 
 # Override per-request:
-client.with_options(timeout=5.0).v1.materials.list()
+client.with_options(timeout=5.0).v1.components.create(
+    config={"model": "gpt-4o-mini-2024-07-18"},
+    name="My Study Component",
+    origin="api",
+    type="flashcards",
+)
 ```
 
 On timeout, an `APITimeoutError` is thrown.
@@ -294,11 +327,18 @@ The "raw" Response object can be accessed by prefixing `.with_raw_response.` to
 from studyfetch_sdk import StudyfetchSDK
 
 client = StudyfetchSDK()
-response = client.v1.materials.with_raw_response.list()
+response = client.v1.components.with_raw_response.create(
+    config={
+        "model": "gpt-4o-mini-2024-07-18"
+    },
+    name="My Study Component",
+    origin="api",
+    type="flashcards",
+)
 print(response.headers.get('X-My-Header'))
 
-material = response.parse()  # get the object that `v1.materials.list()` would have returned
-print(material)
+component = response.parse()  # get the object that `v1.components.create()` would have returned
+print(component._id)
 ```
 
 These methods return an [`APIResponse`](https://github.com/GoStudyFetchGo/studyfetch-sdk-python/tree/main/src/studyfetch_sdk/_response.py) object.
@@ -312,7 +352,12 @@ The above interface eagerly reads the full response body when you make the reque
 To stream the response body, use `.with_streaming_response` instead, which requires a context manager and only reads the response body once you call `.read()`, `.text()`, `.json()`, `.iter_bytes()`, `.iter_text()`, `.iter_lines()` or `.parse()`. In the async client, these are async methods.
 
 ```python
-with client.v1.materials.with_streaming_response.list() as response:
+with client.v1.components.with_streaming_response.create(
+    config={"model": "gpt-4o-mini-2024-07-18"},
+    name="My Study Component",
+    origin="api",
+    type="flashcards",
+) as response:
     print(response.headers.get("X-My-Header"))
 
     for line in response.iter_lines():

{studyfetch_sdk-0.1.0a8 → studyfetch_sdk-0.1.0a9}/README.md

@@ -32,7 +32,13 @@ client = StudyfetchSDK(
     api_key=os.environ.get("STUDYFETCH_SDK_API_KEY"),  # This is the default and can be omitted
 )
 
-materials = client.v1.materials.list()
+component = client.v1.components.create(
+    config={"model": "gpt-4o-mini-2024-07-18"},
+    name="My Study Component",
+    origin="api",
+    type="flashcards",
+)
+print(component._id)
 ```
 
 While you can provide an `api_key` keyword argument,
@@ -55,7 +61,13 @@ client = AsyncStudyfetchSDK(
 
 
 async def main() -> None:
-    materials = await client.v1.materials.list()
+    component = await client.v1.components.create(
+        config={"model": "gpt-4o-mini-2024-07-18"},
+        name="My Study Component",
+        origin="api",
+        type="flashcards",
+    )
+    print(component._id)
 
 
 asyncio.run(main())
@@ -87,7 +99,13 @@ async def main() -> None:
         api_key="My API Key",
         http_client=DefaultAioHttpClient(),
     ) as client:
-        materials = await client.v1.materials.list()
+        component = await client.v1.components.create(
+            config={"model": "gpt-4o-mini-2024-07-18"},
+            name="My Study Component",
+            origin="api",
+            type="flashcards",
+        )
+        print(component._id)
 
 
 asyncio.run(main())
@@ -152,7 +170,12 @@ from studyfetch_sdk import StudyfetchSDK
 client = StudyfetchSDK()
 
 try:
-    client.v1.materials.list()
+    client.v1.components.create(
+        config={"model": "gpt-4o-mini-2024-07-18"},
+        name="My Study Component",
+        origin="api",
+        type="flashcards",
+    )
 except studyfetch_sdk.APIConnectionError as e:
     print("The server could not be reached")
     print(e.__cause__)  # an underlying Exception, likely raised within httpx.
@@ -195,7 +218,12 @@ client = StudyfetchSDK(
 )
 
 # Or, configure per-request:
-client.with_options(max_retries=5).v1.materials.list()
+client.with_options(max_retries=5).v1.components.create(
+    config={"model": "gpt-4o-mini-2024-07-18"},
+    name="My Study Component",
+    origin="api",
+    type="flashcards",
+)
 ```
 
 ### Timeouts
@@ -218,7 +246,12 @@ client = StudyfetchSDK(
 )
 
 # Override per-request:
-client.with_options(timeout=5.0).v1.materials.list()
+client.with_options(timeout=5.0).v1.components.create(
+    config={"model": "gpt-4o-mini-2024-07-18"},
+    name="My Study Component",
+    origin="api",
+    type="flashcards",
+)
 ```
 
 On timeout, an `APITimeoutError` is thrown.
@@ -259,11 +292,18 @@ The "raw" Response object can be accessed by prefixing `.with_raw_response.` to
 from studyfetch_sdk import StudyfetchSDK
 
 client = StudyfetchSDK()
-response = client.v1.materials.with_raw_response.list()
+response = client.v1.components.with_raw_response.create(
+    config={
+        "model": "gpt-4o-mini-2024-07-18"
+    },
+    name="My Study Component",
+    origin="api",
+    type="flashcards",
+)
 print(response.headers.get('X-My-Header'))
 
-material = response.parse()  # get the object that `v1.materials.list()` would have returned
-print(material)
+component = response.parse()  # get the object that `v1.components.create()` would have returned
+print(component._id)
 ```
 
 These methods return an [`APIResponse`](https://github.com/GoStudyFetchGo/studyfetch-sdk-python/tree/main/src/studyfetch_sdk/_response.py) object.
@@ -277,7 +317,12 @@ The above interface eagerly reads the full response body when you make the reque
 To stream the response body, use `.with_streaming_response` instead, which requires a context manager and only reads the response body once you call `.read()`, `.text()`, `.json()`, `.iter_bytes()`, `.iter_text()`, `.iter_lines()` or `.parse()`. In the async client, these are async methods.
 
 ```python
-with client.v1.materials.with_streaming_response.list() as response:
+with client.v1.components.with_streaming_response.create(
+    config={"model": "gpt-4o-mini-2024-07-18"},
+    name="My Study Component",
+    origin="api",
+    type="flashcards",
+) as response:
     print(response.headers.get("X-My-Header"))
 
     for line in response.iter_lines():

{studyfetch_sdk-0.1.0a8 → studyfetch_sdk-0.1.0a9}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "studyfetch_sdk"
-version = "0.1.0-alpha.8"
+version = "0.1.0-alpha.9"
 description = "The official Python library for the studyfetch-sdk API"
 dynamic = ["readme"]
 license = "Apache-2.0"

{studyfetch_sdk-0.1.0a8 → studyfetch_sdk-0.1.0a9}/src/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.8"  # x-release-please-version
+__version__ = "0.1.0-alpha.9"  # x-release-please-version

{studyfetch_sdk-0.1.0a8 → studyfetch_sdk-0.1.0a9}/tests/test_client.py

@@ -724,20 +724,24 @@ class TestStudyfetchSDK:
     @mock.patch("studyfetch_sdk._base_client.BaseClient._calculate_retry_timeout", _low_retry_timeout)
     @pytest.mark.respx(base_url=base_url)
     def test_retrying_timeout_errors_doesnt_leak(self, respx_mock: MockRouter, client: StudyfetchSDK) -> None:
-        respx_mock.get("/api/v1/materials").mock(side_effect=httpx.TimeoutException("Test timeout error"))
+        respx_mock.post("/api/v1/components").mock(side_effect=httpx.TimeoutException("Test timeout error"))
 
         with pytest.raises(APITimeoutError):
-            client.v1.materials.with_streaming_response.list().__enter__()
+            client.v1.components.with_streaming_response.create(
+                config={"model": "gpt-4o-mini-2024-07-18"}, name="My Study Component", origin="chat", type="chat"
+            ).__enter__()
 
         assert _get_open_connections(self.client) == 0
 
     @mock.patch("studyfetch_sdk._base_client.BaseClient._calculate_retry_timeout", _low_retry_timeout)
     @pytest.mark.respx(base_url=base_url)
     def test_retrying_status_errors_doesnt_leak(self, respx_mock: MockRouter, client: StudyfetchSDK) -> None:
-        respx_mock.get("/api/v1/materials").mock(return_value=httpx.Response(500))
+        respx_mock.post("/api/v1/components").mock(return_value=httpx.Response(500))
 
         with pytest.raises(APIStatusError):
-            client.v1.materials.with_streaming_response.list().__enter__()
+            client.v1.components.with_streaming_response.create(
+                config={"model": "gpt-4o-mini-2024-07-18"}, name="My Study Component", origin="chat", type="chat"
+            ).__enter__()
         assert _get_open_connections(self.client) == 0
 
     @pytest.mark.parametrize("failures_before_success", [0, 2, 4])
@@ -764,9 +768,11 @@ class TestStudyfetchSDK:
                 return httpx.Response(500)
             return httpx.Response(200)
 
-        respx_mock.get("/api/v1/materials").mock(side_effect=retry_handler)
+        respx_mock.post("/api/v1/components").mock(side_effect=retry_handler)
 
-        response = client.v1.materials.with_raw_response.list()
+        response = client.v1.components.with_raw_response.create(
+            config={"model": "gpt-4o-mini-2024-07-18"}, name="My Study Component", origin="chat", type="chat"
+        )
 
         assert response.retries_taken == failures_before_success
         assert int(response.http_request.headers.get("x-stainless-retry-count")) == failures_before_success
@@ -788,9 +794,15 @@ class TestStudyfetchSDK:
                 return httpx.Response(500)
             return httpx.Response(200)
 
-        respx_mock.get("/api/v1/materials").mock(side_effect=retry_handler)
+        respx_mock.post("/api/v1/components").mock(side_effect=retry_handler)
 
-        response = client.v1.materials.with_raw_response.list(extra_headers={"x-stainless-retry-count": Omit()})
+        response = client.v1.components.with_raw_response.create(
+            config={"model": "gpt-4o-mini-2024-07-18"},
+            name="My Study Component",
+            origin="chat",
+            type="chat",
+            extra_headers={"x-stainless-retry-count": Omit()},
+        )
 
         assert len(response.http_request.headers.get_list("x-stainless-retry-count")) == 0
 
@@ -811,9 +823,15 @@ class TestStudyfetchSDK:
                 return httpx.Response(500)
             return httpx.Response(200)
 
-        respx_mock.get("/api/v1/materials").mock(side_effect=retry_handler)
+        respx_mock.post("/api/v1/components").mock(side_effect=retry_handler)
 
-        response = client.v1.materials.with_raw_response.list(extra_headers={"x-stainless-retry-count": "42"})
+        response = client.v1.components.with_raw_response.create(
+            config={"model": "gpt-4o-mini-2024-07-18"},
+            name="My Study Component",
+            origin="chat",
+            type="chat",
+            extra_headers={"x-stainless-retry-count": "42"},
+        )
 
         assert response.http_request.headers.get("x-stainless-retry-count") == "42"
 
@@ -1541,10 +1559,12 @@ class TestAsyncStudyfetchSDK:
     async def test_retrying_timeout_errors_doesnt_leak(
         self, respx_mock: MockRouter, async_client: AsyncStudyfetchSDK
     ) -> None:
-        respx_mock.get("/api/v1/materials").mock(side_effect=httpx.TimeoutException("Test timeout error"))
+        respx_mock.post("/api/v1/components").mock(side_effect=httpx.TimeoutException("Test timeout error"))
 
         with pytest.raises(APITimeoutError):
-            await async_client.v1.materials.with_streaming_response.list().__aenter__()
+            await async_client.v1.components.with_streaming_response.create(
+                config={"model": "gpt-4o-mini-2024-07-18"}, name="My Study Component", origin="chat", type="chat"
+            ).__aenter__()
 
         assert _get_open_connections(self.client) == 0
 
@@ -1553,10 +1573,12 @@ class TestAsyncStudyfetchSDK:
     async def test_retrying_status_errors_doesnt_leak(
         self, respx_mock: MockRouter, async_client: AsyncStudyfetchSDK
     ) -> None:
-        respx_mock.get("/api/v1/materials").mock(return_value=httpx.Response(500))
+        respx_mock.post("/api/v1/components").mock(return_value=httpx.Response(500))
 
         with pytest.raises(APIStatusError):
-            await async_client.v1.materials.with_streaming_response.list().__aenter__()
+            await async_client.v1.components.with_streaming_response.create(
+                config={"model": "gpt-4o-mini-2024-07-18"}, name="My Study Component", origin="chat", type="chat"
+            ).__aenter__()
         assert _get_open_connections(self.client) == 0
 
     @pytest.mark.parametrize("failures_before_success", [0, 2, 4])
@@ -1584,9 +1606,11 @@ class TestAsyncStudyfetchSDK:
                 return httpx.Response(500)
             return httpx.Response(200)
 
-        respx_mock.get("/api/v1/materials").mock(side_effect=retry_handler)
+        respx_mock.post("/api/v1/components").mock(side_effect=retry_handler)
 
-        response = await client.v1.materials.with_raw_response.list()
+        response = await client.v1.components.with_raw_response.create(
+            config={"model": "gpt-4o-mini-2024-07-18"}, name="My Study Component", origin="chat", type="chat"
+        )
 
         assert response.retries_taken == failures_before_success
         assert int(response.http_request.headers.get("x-stainless-retry-count")) == failures_before_success
@@ -1609,9 +1633,15 @@ class TestAsyncStudyfetchSDK:
                 return httpx.Response(500)
             return httpx.Response(200)
 
-        respx_mock.get("/api/v1/materials").mock(side_effect=retry_handler)
+        respx_mock.post("/api/v1/components").mock(side_effect=retry_handler)
 
-        response = await client.v1.materials.with_raw_response.list(extra_headers={"x-stainless-retry-count": Omit()})
+        response = await client.v1.components.with_raw_response.create(
+            config={"model": "gpt-4o-mini-2024-07-18"},
+            name="My Study Component",
+            origin="chat",
+            type="chat",
+            extra_headers={"x-stainless-retry-count": Omit()},
+        )
 
         assert len(response.http_request.headers.get_list("x-stainless-retry-count")) == 0
 
@@ -1633,9 +1663,15 @@ class TestAsyncStudyfetchSDK:
                 return httpx.Response(500)
             return httpx.Response(200)
 
-        respx_mock.get("/api/v1/materials").mock(side_effect=retry_handler)
+        respx_mock.post("/api/v1/components").mock(side_effect=retry_handler)
 
-        response = await client.v1.materials.with_raw_response.list(extra_headers={"x-stainless-retry-count": "42"})
+        response = await client.v1.components.with_raw_response.create(
+            config={"model": "gpt-4o-mini-2024-07-18"},
+            name="My Study Component",
+            origin="chat",
+            type="chat",
+            extra_headers={"x-stainless-retry-count": "42"},
+        )
 
         assert response.http_request.headers.get("x-stainless-retry-count") == "42"
 

studyfetch_sdk-0.1.0a8/.release-please-manifest.json

@@ -1,3 +0,0 @@
-{
-  ".": "0.1.0-alpha.8"
-}