studyfetch-sdk 0.1.0a5__tar.gz → 0.1.0a6__tar.gz

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

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

{studyfetch_sdk-0.1.0a5 → studyfetch_sdk-0.1.0a6}/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## 0.1.0-alpha.6 (2025-07-20)
+
+Full Changelog: [v0.1.0-alpha.5...v0.1.0-alpha.6](https://github.com/GoStudyFetchGo/studyfetch-sdk-python/compare/v0.1.0-alpha.5...v0.1.0-alpha.6)
+
+### Features
+
+* **api:** api update ([bfe5ea5](https://github.com/GoStudyFetchGo/studyfetch-sdk-python/commit/bfe5ea57c3791889ceb0256b004b4cc55357b0e7))
+* **api:** manual updates ([efade2c](https://github.com/GoStudyFetchGo/studyfetch-sdk-python/commit/efade2c650c84da705e4707664b45e8b675860e1))
+* **api:** manual updates ([6199f6a](https://github.com/GoStudyFetchGo/studyfetch-sdk-python/commit/6199f6a98e6252700e0ec231856655b467d9ac97))
+
 ## 0.1.0-alpha.5 (2025-07-20)
 
 Full Changelog: [v0.1.0-alpha.4...v0.1.0-alpha.5](https://github.com/GoStudyFetchGo/studyfetch-sdk-python/compare/v0.1.0-alpha.4...v0.1.0-alpha.5)

{studyfetch_sdk-0.1.0a5 → studyfetch_sdk-0.1.0a6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: studyfetch_sdk
-Version: 0.1.0a5
+Version: 0.1.0a6
 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
@@ -46,7 +46,7 @@ It is generated with [Stainless](https://www.stainless.com/).
 
 ## Documentation
 
-The REST API documentation can be found on [studyfetch.com](https://studyfetch.com/docs). The full API of this library can be found in [api.md](https://github.com/GoStudyFetchGo/studyfetch-sdk-python/tree/main/api.md).
+The full API of this library can be found in [api.md](https://github.com/GoStudyFetchGo/studyfetch-sdk-python/tree/main/api.md).
 
 ## Installation
 
@@ -67,7 +67,9 @@ client = StudyfetchSDK(
     api_key=os.environ.get("STUDYFETCH_SDK_API_KEY"),  # This is the default and can be omitted
 )
 
-client.v1.auth.verify_reset_token()
+client.v1.auth.number_2fa.send_code(
+    email="user@example.com",
+)
 ```
 
 While you can provide an `api_key` keyword argument,
@@ -90,7 +92,9 @@ client = AsyncStudyfetchSDK(
 
 
 async def main() -> None:
-    await client.v1.auth.verify_reset_token()
+    await client.v1.auth.number_2fa.send_code(
+        email="user@example.com",
+    )
 
 
 asyncio.run(main())
@@ -122,7 +126,9 @@ async def main() -> None:
         api_key="My API Key",
         http_client=DefaultAioHttpClient(),
     ) as client:
-        await client.v1.auth.verify_reset_token()
+        await client.v1.auth.number_2fa.send_code(
+            email="user@example.com",
+        )
 
 
 asyncio.run(main())
@@ -187,7 +193,9 @@ from studyfetch_sdk import StudyfetchSDK
 client = StudyfetchSDK()
 
 try:
-    client.v1.auth.verify_reset_token()
+    client.v1.auth.number_2fa.send_code(
+        email="user@example.com",
+    )
 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 +238,9 @@ client = StudyfetchSDK(
 )
 
 # Or, configure per-request:
-client.with_options(max_retries=5).v1.auth.verify_reset_token()
+client.with_options(max_retries=5).v1.auth.number_2fa.send_code(
+    email="user@example.com",
+)
 ```
 
 ### Timeouts
@@ -253,7 +263,9 @@ client = StudyfetchSDK(
 )
 
 # Override per-request:
-client.with_options(timeout=5.0).v1.auth.verify_reset_token()
+client.with_options(timeout=5.0).v1.auth.number_2fa.send_code(
+    email="user@example.com",
+)
 ```
 
 On timeout, an `APITimeoutError` is thrown.
@@ -294,11 +306,13 @@ The "raw" Response object can be accessed by prefixing `.with_raw_response.` to
 from studyfetch_sdk import StudyfetchSDK
 
 client = StudyfetchSDK()
-response = client.v1.auth.with_raw_response.verify_reset_token()
+response = client.v1.auth.number_2fa.with_raw_response.send_code(
+    email="user@example.com",
+)
 print(response.headers.get('X-My-Header'))
 
-auth = response.parse()  # get the object that `v1.auth.verify_reset_token()` would have returned
-print(auth)
+number_2fa = response.parse()  # get the object that `v1.auth.number_2fa.send_code()` would have returned
+print(number_2fa)
 ```
 
 These methods return an [`APIResponse`](https://github.com/GoStudyFetchGo/studyfetch-sdk-python/tree/main/src/studyfetch_sdk/_response.py) object.
@@ -312,7 +326,9 @@ 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.auth.with_streaming_response.verify_reset_token() as response:
+with client.v1.auth.number_2fa.with_streaming_response.send_code(
+    email="user@example.com",
+) as response:
     print(response.headers.get("X-My-Header"))
 
     for line in response.iter_lines():

{studyfetch_sdk-0.1.0a5 → studyfetch_sdk-0.1.0a6}/README.md

@@ -11,7 +11,7 @@ It is generated with [Stainless](https://www.stainless.com/).
 
 ## Documentation
 
-The REST API documentation can be found on [studyfetch.com](https://studyfetch.com/docs). The full API of this library can be found in [api.md](api.md).
+The full API of this library can be found in [api.md](api.md).
 
 ## Installation
 
@@ -32,7 +32,9 @@ client = StudyfetchSDK(
     api_key=os.environ.get("STUDYFETCH_SDK_API_KEY"),  # This is the default and can be omitted
 )
 
-client.v1.auth.verify_reset_token()
+client.v1.auth.number_2fa.send_code(
+    email="user@example.com",
+)
 ```
 
 While you can provide an `api_key` keyword argument,
@@ -55,7 +57,9 @@ client = AsyncStudyfetchSDK(
 
 
 async def main() -> None:
-    await client.v1.auth.verify_reset_token()
+    await client.v1.auth.number_2fa.send_code(
+        email="user@example.com",
+    )
 
 
 asyncio.run(main())
@@ -87,7 +91,9 @@ async def main() -> None:
         api_key="My API Key",
         http_client=DefaultAioHttpClient(),
     ) as client:
-        await client.v1.auth.verify_reset_token()
+        await client.v1.auth.number_2fa.send_code(
+            email="user@example.com",
+        )
 
 
 asyncio.run(main())
@@ -152,7 +158,9 @@ from studyfetch_sdk import StudyfetchSDK
 client = StudyfetchSDK()
 
 try:
-    client.v1.auth.verify_reset_token()
+    client.v1.auth.number_2fa.send_code(
+        email="user@example.com",
+    )
 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 +203,9 @@ client = StudyfetchSDK(
 )
 
 # Or, configure per-request:
-client.with_options(max_retries=5).v1.auth.verify_reset_token()
+client.with_options(max_retries=5).v1.auth.number_2fa.send_code(
+    email="user@example.com",
+)
 ```
 
 ### Timeouts
@@ -218,7 +228,9 @@ client = StudyfetchSDK(
 )
 
 # Override per-request:
-client.with_options(timeout=5.0).v1.auth.verify_reset_token()
+client.with_options(timeout=5.0).v1.auth.number_2fa.send_code(
+    email="user@example.com",
+)
 ```
 
 On timeout, an `APITimeoutError` is thrown.
@@ -259,11 +271,13 @@ The "raw" Response object can be accessed by prefixing `.with_raw_response.` to
 from studyfetch_sdk import StudyfetchSDK
 
 client = StudyfetchSDK()
-response = client.v1.auth.with_raw_response.verify_reset_token()
+response = client.v1.auth.number_2fa.with_raw_response.send_code(
+    email="user@example.com",
+)
 print(response.headers.get('X-My-Header'))
 
-auth = response.parse()  # get the object that `v1.auth.verify_reset_token()` would have returned
-print(auth)
+number_2fa = response.parse()  # get the object that `v1.auth.number_2fa.send_code()` would have returned
+print(number_2fa)
 ```
 
 These methods return an [`APIResponse`](https://github.com/GoStudyFetchGo/studyfetch-sdk-python/tree/main/src/studyfetch_sdk/_response.py) object.
@@ -277,7 +291,9 @@ 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.auth.with_streaming_response.verify_reset_token() as response:
+with client.v1.auth.number_2fa.with_streaming_response.send_code(
+    email="user@example.com",
+) as response:
     print(response.headers.get("X-My-Header"))
 
     for line in response.iter_lines():

{studyfetch_sdk-0.1.0a5 → studyfetch_sdk-0.1.0a6}/api.md

@@ -17,20 +17,16 @@ Methods:
 Types:
 
 ```python
-from studyfetch_sdk.types.v1 import (
-    MaterialCreateResponse,
-    MaterialRetrieveResponse,
-    MaterialListResponse,
-)
+from studyfetch_sdk.types.v1 import Material, MaterialListResponse
 ```
 
 Methods:
 
-- <code title="post /api/v1/materials">client.v1.materials.<a href="./src/studyfetch_sdk/resources/v1/materials/materials.py">create</a>(\*\*<a href="src/studyfetch_sdk/types/v1/material_create_params.py">params</a>) -> <a href="./src/studyfetch_sdk/types/v1/material_create_response.py">MaterialCreateResponse</a></code>
-- <code title="get /api/v1/materials/{id}">client.v1.materials.<a href="./src/studyfetch_sdk/resources/v1/materials/materials.py">retrieve</a>(id) -> <a href="./src/studyfetch_sdk/types/v1/material_retrieve_response.py">MaterialRetrieveResponse</a></code>
+- <code title="post /api/v1/materials">client.v1.materials.<a href="./src/studyfetch_sdk/resources/v1/materials/materials.py">create</a>(\*\*<a href="src/studyfetch_sdk/types/v1/material_create_params.py">params</a>) -> <a href="./src/studyfetch_sdk/types/v1/material.py">Material</a></code>
+- <code title="get /api/v1/materials/{id}">client.v1.materials.<a href="./src/studyfetch_sdk/resources/v1/materials/materials.py">retrieve</a>(id) -> <a href="./src/studyfetch_sdk/types/v1/material.py">Material</a></code>
 - <code title="get /api/v1/materials">client.v1.materials.<a href="./src/studyfetch_sdk/resources/v1/materials/materials.py">list</a>(\*\*<a href="src/studyfetch_sdk/types/v1/material_list_params.py">params</a>) -> <a href="./src/studyfetch_sdk/types/v1/material_list_response.py">MaterialListResponse</a></code>
 - <code title="delete /api/v1/materials/{id}">client.v1.materials.<a href="./src/studyfetch_sdk/resources/v1/materials/materials.py">delete</a>(id) -> None</code>
-- <code title="post /api/v1/materials/batch">client.v1.materials.<a href="./src/studyfetch_sdk/resources/v1/materials/materials.py">create_batch</a>() -> None</code>
+- <code title="post /api/v1/materials/batch">client.v1.materials.<a href="./src/studyfetch_sdk/resources/v1/materials/materials.py">batch_create</a>() -> None</code>
 - <code title="get /api/v1/materials/{id}/debug">client.v1.materials.<a href="./src/studyfetch_sdk/resources/v1/materials/materials.py">debug</a>(id) -> None</code>
 - <code title="get /api/v1/materials/{id}/download-url">client.v1.materials.<a href="./src/studyfetch_sdk/resources/v1/materials/materials.py">get_download_url</a>(id, \*\*<a href="src/studyfetch_sdk/types/v1/material_get_download_url_params.py">params</a>) -> None</code>
 - <code title="post /api/v1/materials/{id}/move">client.v1.materials.<a href="./src/studyfetch_sdk/resources/v1/materials/materials.py">move</a>(id) -> None</code>
@@ -40,18 +36,12 @@ Methods:
 
 ### Upload
 
-Types:
-
-```python
-from studyfetch_sdk.types.v1.materials import UploadUploadFileResponse, UploadUploadFromURLResponse
-```
-
 Methods:
 
 - <code title="post /api/v1/materials/upload/complete">client.v1.materials.upload.<a href="./src/studyfetch_sdk/resources/v1/materials/upload.py">complete_upload</a>() -> None</code>
-- <code title="post /api/v1/materials/upload/presigned-url">client.v1.materials.upload.<a href="./src/studyfetch_sdk/resources/v1/materials/upload.py">get_presigned_url</a>() -> None</code>
-- <code title="post /api/v1/materials/upload">client.v1.materials.upload.<a href="./src/studyfetch_sdk/resources/v1/materials/upload.py">upload_file</a>(\*\*<a href="src/studyfetch_sdk/types/v1/materials/upload_upload_file_params.py">params</a>) -> <a href="./src/studyfetch_sdk/types/v1/materials/upload_upload_file_response.py">UploadUploadFileResponse</a></code>
-- <code title="post /api/v1/materials/upload/url">client.v1.materials.upload.<a href="./src/studyfetch_sdk/resources/v1/materials/upload.py">upload_from_url</a>(\*\*<a href="src/studyfetch_sdk/types/v1/materials/upload_upload_from_url_params.py">params</a>) -> <a href="./src/studyfetch_sdk/types/v1/materials/upload_upload_from_url_response.py">UploadUploadFromURLResponse</a></code>
+- <code title="post /api/v1/materials/upload/presigned-url">client.v1.materials.upload.<a href="./src/studyfetch_sdk/resources/v1/materials/upload.py">create_presigned_url</a>() -> None</code>
+- <code title="post /api/v1/materials/upload">client.v1.materials.upload.<a href="./src/studyfetch_sdk/resources/v1/materials/upload.py">upload_file</a>(\*\*<a href="src/studyfetch_sdk/types/v1/materials/upload_upload_file_params.py">params</a>) -> <a href="./src/studyfetch_sdk/types/v1/material.py">Material</a></code>
+- <code title="post /api/v1/materials/upload/url">client.v1.materials.upload.<a href="./src/studyfetch_sdk/resources/v1/materials/upload.py">upload_from_url</a>(\*\*<a href="src/studyfetch_sdk/types/v1/materials/upload_upload_from_url_params.py">params</a>) -> <a href="./src/studyfetch_sdk/types/v1/material.py">Material</a></code>
 
 ### Bulk
 
@@ -68,14 +58,6 @@ Methods:
 - <code title="post /api/v1/materials/test/image-processing">client.v1.materials.test.<a href="./src/studyfetch_sdk/resources/v1/materials/test.py">process_image</a>() -> None</code>
 - <code title="post /api/v1/materials/test/video-processing">client.v1.materials.test.<a href="./src/studyfetch_sdk/resources/v1/materials/test.py">process_video</a>() -> None</code>
 
-## Usage
-
-Methods:
-
-- <code title="get /api/v1/usage/stats">client.v1.usage.<a href="./src/studyfetch_sdk/resources/v1/usage.py">get_stats</a>(\*\*<a href="src/studyfetch_sdk/types/v1/usage_get_stats_params.py">params</a>) -> None</code>
-- <code title="get /api/v1/usage/summary">client.v1.usage.<a href="./src/studyfetch_sdk/resources/v1/usage.py">get_summary</a>(\*\*<a href="src/studyfetch_sdk/types/v1/usage_get_summary_params.py">params</a>) -> None</code>
-- <code title="get /api/v1/usage/events">client.v1.usage.<a href="./src/studyfetch_sdk/resources/v1/usage.py">list_events</a>(\*\*<a href="src/studyfetch_sdk/types/v1/usage_list_events_params.py">params</a>) -> None</code>
-
 ## Folders
 
 Methods:
@@ -94,27 +76,29 @@ Methods:
 Types:
 
 ```python
-from studyfetch_sdk.types.v1 import (
-    ComponentCreateResponse,
-    ComponentRetrieveResponse,
-    ComponentUpdateResponse,
-    ComponentListResponse,
-    ComponentEmbedResponse,
-)
+from studyfetch_sdk.types.v1 import Component, ComponentListResponse, ComponentGenerateEmbedResponse
 ```
 
 Methods:
 
-- <code title="post /api/v1/components">client.v1.components.<a href="./src/studyfetch_sdk/resources/v1/components.py">create</a>(\*\*<a href="src/studyfetch_sdk/types/v1/component_create_params.py">params</a>) -> <a href="./src/studyfetch_sdk/types/v1/component_create_response.py">ComponentCreateResponse</a></code>
-- <code title="get /api/v1/components/{id}">client.v1.components.<a href="./src/studyfetch_sdk/resources/v1/components.py">retrieve</a>(id) -> <a href="./src/studyfetch_sdk/types/v1/component_retrieve_response.py">ComponentRetrieveResponse</a></code>
-- <code title="patch /api/v1/components/{id}">client.v1.components.<a href="./src/studyfetch_sdk/resources/v1/components.py">update</a>(id, \*\*<a href="src/studyfetch_sdk/types/v1/component_update_params.py">params</a>) -> <a href="./src/studyfetch_sdk/types/v1/component_update_response.py">ComponentUpdateResponse</a></code>
+- <code title="post /api/v1/components">client.v1.components.<a href="./src/studyfetch_sdk/resources/v1/components.py">create</a>(\*\*<a href="src/studyfetch_sdk/types/v1/component_create_params.py">params</a>) -> <a href="./src/studyfetch_sdk/types/v1/component.py">Component</a></code>
+- <code title="get /api/v1/components/{id}">client.v1.components.<a href="./src/studyfetch_sdk/resources/v1/components.py">retrieve</a>(id) -> <a href="./src/studyfetch_sdk/types/v1/component.py">Component</a></code>
+- <code title="patch /api/v1/components/{id}">client.v1.components.<a href="./src/studyfetch_sdk/resources/v1/components.py">update</a>(id, \*\*<a href="src/studyfetch_sdk/types/v1/component_update_params.py">params</a>) -> <a href="./src/studyfetch_sdk/types/v1/component.py">Component</a></code>
 - <code title="get /api/v1/components">client.v1.components.<a href="./src/studyfetch_sdk/resources/v1/components.py">list</a>(\*\*<a href="src/studyfetch_sdk/types/v1/component_list_params.py">params</a>) -> <a href="./src/studyfetch_sdk/types/v1/component_list_response.py">ComponentListResponse</a></code>
 - <code title="delete /api/v1/components/{id}">client.v1.components.<a href="./src/studyfetch_sdk/resources/v1/components.py">delete</a>(id) -> None</code>
 - <code title="post /api/v1/components/{id}/activate">client.v1.components.<a href="./src/studyfetch_sdk/resources/v1/components.py">activate</a>(id) -> None</code>
 - <code title="post /api/v1/components/{id}/deactivate">client.v1.components.<a href="./src/studyfetch_sdk/resources/v1/components.py">deactivate</a>(id) -> None</code>
-- <code title="post /api/v1/components/{id}/embed">client.v1.components.<a href="./src/studyfetch_sdk/resources/v1/components.py">embed</a>(id, \*\*<a href="src/studyfetch_sdk/types/v1/component_embed_params.py">params</a>) -> <a href="./src/studyfetch_sdk/types/v1/component_embed_response.py">ComponentEmbedResponse</a></code>
+- <code title="post /api/v1/components/{id}/embed">client.v1.components.<a href="./src/studyfetch_sdk/resources/v1/components.py">generate_embed</a>(id, \*\*<a href="src/studyfetch_sdk/types/v1/component_generate_embed_params.py">params</a>) -> <a href="./src/studyfetch_sdk/types/v1/component_generate_embed_response.py">ComponentGenerateEmbedResponse</a></code>
 - <code title="post /api/v1/components/{id}/interact">client.v1.components.<a href="./src/studyfetch_sdk/resources/v1/components.py">interact</a>(id) -> None</code>
 
+## Usage
+
+Methods:
+
+- <code title="get /api/v1/usage/stats">client.v1.usage.<a href="./src/studyfetch_sdk/resources/v1/usage.py">get_stats</a>(\*\*<a href="src/studyfetch_sdk/types/v1/usage_get_stats_params.py">params</a>) -> None</code>
+- <code title="get /api/v1/usage/summary">client.v1.usage.<a href="./src/studyfetch_sdk/resources/v1/usage.py">get_summary</a>(\*\*<a href="src/studyfetch_sdk/types/v1/usage_get_summary_params.py">params</a>) -> None</code>
+- <code title="get /api/v1/usage/events">client.v1.usage.<a href="./src/studyfetch_sdk/resources/v1/usage.py">list_events</a>(\*\*<a href="src/studyfetch_sdk/types/v1/usage_list_events_params.py">params</a>) -> None</code>
+
 ## Embed
 
 Methods:
@@ -135,7 +119,7 @@ Methods:
 Methods:
 
 - <code title="post /api/v1/chat/history">client.v1.chat.<a href="./src/studyfetch_sdk/resources/v1/chat/chat.py">get_history</a>() -> None</code>
-- <code title="get /api/v1/chat/session/{sessionId}">client.v1.chat.<a href="./src/studyfetch_sdk/resources/v1/chat/chat.py">retrieve_session</a>(session_id, \*\*<a href="src/studyfetch_sdk/types/v1/chat_retrieve_session_params.py">params</a>) -> None</code>
+- <code title="get /api/v1/chat/session/{sessionId}">client.v1.chat.<a href="./src/studyfetch_sdk/resources/v1/chat/chat.py">get_session</a>(session_id, \*\*<a href="src/studyfetch_sdk/types/v1/chat_get_session_params.py">params</a>) -> None</code>
 - <code title="post /api/v1/chat/followups">client.v1.chat.<a href="./src/studyfetch_sdk/resources/v1/chat/chat.py">send_followups</a>() -> None</code>
 - <code title="post /api/v1/chat/message">client.v1.chat.<a href="./src/studyfetch_sdk/resources/v1/chat/chat.py">send_message</a>(\*\*<a href="src/studyfetch_sdk/types/v1/chat_send_message_params.py">params</a>) -> None</code>
 - <code title="post /api/v1/chat/stream">client.v1.chat.<a href="./src/studyfetch_sdk/resources/v1/chat/chat.py">stream</a>(\*\*<a href="src/studyfetch_sdk/types/v1/chat_stream_params.py">params</a>) -> None</code>
@@ -154,28 +138,6 @@ Methods:
 - <code title="post /api/v1/chat/test/image-citation">client.v1.chat.test.<a href="./src/studyfetch_sdk/resources/v1/chat/test.py">cite_image</a>() -> None</code>
 - <code title="post /api/v1/chat/test/image">client.v1.chat.test.<a href="./src/studyfetch_sdk/resources/v1/chat/test.py">upload_image</a>() -> None</code>
 
-## Flashcards
-
-Types:
-
-```python
-from studyfetch_sdk.types.v1 import (
-    FlashcardBatchProcessResponse,
-    FlashcardGetAlgorithmInfoResponse,
-    FlashcardGetTypesResponse,
-)
-```
-
-Methods:
-
-- <code title="post /api/v1/flashcards/{componentId}/batch">client.v1.flashcards.<a href="./src/studyfetch_sdk/resources/v1/flashcards.py">batch_process</a>(component_id, \*\*<a href="src/studyfetch_sdk/types/v1/flashcard_batch_process_params.py">params</a>) -> <a href="./src/studyfetch_sdk/types/v1/flashcard_batch_process_response.py">FlashcardBatchProcessResponse</a></code>
-- <code title="get /api/v1/flashcards/algorithm">client.v1.flashcards.<a href="./src/studyfetch_sdk/resources/v1/flashcards.py">get_algorithm_info</a>() -> <a href="./src/studyfetch_sdk/types/v1/flashcard_get_algorithm_info_response.py">FlashcardGetAlgorithmInfoResponse</a></code>
-- <code title="get /api/v1/flashcards/{componentId}/all">client.v1.flashcards.<a href="./src/studyfetch_sdk/resources/v1/flashcards.py">get_all</a>(component_id, \*\*<a href="src/studyfetch_sdk/types/v1/flashcard_get_all_params.py">params</a>) -> None</code>
-- <code title="get /api/v1/flashcards/{componentId}/due">client.v1.flashcards.<a href="./src/studyfetch_sdk/resources/v1/flashcards.py">get_due</a>(component_id, \*\*<a href="src/studyfetch_sdk/types/v1/flashcard_get_due_params.py">params</a>) -> None</code>
-- <code title="get /api/v1/flashcards/{componentId}/stats">client.v1.flashcards.<a href="./src/studyfetch_sdk/resources/v1/flashcards.py">get_stats</a>(component_id, \*\*<a href="src/studyfetch_sdk/types/v1/flashcard_get_stats_params.py">params</a>) -> None</code>
-- <code title="get /api/v1/flashcards/types">client.v1.flashcards.<a href="./src/studyfetch_sdk/resources/v1/flashcards.py">get_types</a>() -> <a href="./src/studyfetch_sdk/types/v1/flashcard_get_types_response.py">FlashcardGetTypesResponse</a></code>
-- <code title="post /api/v1/flashcards/{componentId}/rate">client.v1.flashcards.<a href="./src/studyfetch_sdk/resources/v1/flashcards.py">rate</a>(component_id, \*\*<a href="src/studyfetch_sdk/types/v1/flashcard_rate_params.py">params</a>) -> None</code>
-
 ## Tests
 
 Methods:
@@ -208,8 +170,36 @@ Methods:
 - <code title="get /api/v1/audio-recaps/{recapId}/sections/{sectionId}">client.v1.audio_recaps.sections.<a href="./src/studyfetch_sdk/resources/v1/audio_recaps/sections.py">retrieve</a>(section_id, \*, recap_id) -> None</code>
 - <code title="get /api/v1/audio-recaps/{recapId}/sections">client.v1.audio_recaps.sections.<a href="./src/studyfetch_sdk/resources/v1/audio_recaps/sections.py">list</a>(recap_id) -> None</code>
 
+## Flashcards
+
+Types:
+
+```python
+from studyfetch_sdk.types.v1 import (
+    FlashcardBatchProcessResponse,
+    FlashcardGetAlgorithmResponse,
+    FlashcardGetTypesResponse,
+)
+```
+
+Methods:
+
+- <code title="post /api/v1/flashcards/{componentId}/batch">client.v1.flashcards.<a href="./src/studyfetch_sdk/resources/v1/flashcards.py">batch_process</a>(component_id, \*\*<a href="src/studyfetch_sdk/types/v1/flashcard_batch_process_params.py">params</a>) -> <a href="./src/studyfetch_sdk/types/v1/flashcard_batch_process_response.py">FlashcardBatchProcessResponse</a></code>
+- <code title="get /api/v1/flashcards/algorithm">client.v1.flashcards.<a href="./src/studyfetch_sdk/resources/v1/flashcards.py">get_algorithm</a>() -> <a href="./src/studyfetch_sdk/types/v1/flashcard_get_algorithm_response.py">FlashcardGetAlgorithmResponse</a></code>
+- <code title="get /api/v1/flashcards/{componentId}/all">client.v1.flashcards.<a href="./src/studyfetch_sdk/resources/v1/flashcards.py">get_all</a>(component_id, \*\*<a href="src/studyfetch_sdk/types/v1/flashcard_get_all_params.py">params</a>) -> None</code>
+- <code title="get /api/v1/flashcards/{componentId}/due">client.v1.flashcards.<a href="./src/studyfetch_sdk/resources/v1/flashcards.py">get_due</a>(component_id, \*\*<a href="src/studyfetch_sdk/types/v1/flashcard_get_due_params.py">params</a>) -> None</code>
+- <code title="get /api/v1/flashcards/{componentId}/stats">client.v1.flashcards.<a href="./src/studyfetch_sdk/resources/v1/flashcards.py">get_stats</a>(component_id, \*\*<a href="src/studyfetch_sdk/types/v1/flashcard_get_stats_params.py">params</a>) -> None</code>
+- <code title="get /api/v1/flashcards/types">client.v1.flashcards.<a href="./src/studyfetch_sdk/resources/v1/flashcards.py">get_types</a>() -> <a href="./src/studyfetch_sdk/types/v1/flashcard_get_types_response.py">FlashcardGetTypesResponse</a></code>
+- <code title="post /api/v1/flashcards/{componentId}/rate">client.v1.flashcards.<a href="./src/studyfetch_sdk/resources/v1/flashcards.py">rate</a>(component_id, \*\*<a href="src/studyfetch_sdk/types/v1/flashcard_rate_params.py">params</a>) -> None</code>
+
 ## Scenarios
 
+Types:
+
+```python
+from studyfetch_sdk.types.v1 import Scenario
+```
+
 Methods:
 
 - <code title="post /api/v1/scenarios">client.v1.scenarios.<a href="./src/studyfetch_sdk/resources/v1/scenarios/scenarios.py">create</a>(\*\*<a href="src/studyfetch_sdk/types/v1/scenario_create_params.py">params</a>) -> None</code>
@@ -218,7 +208,7 @@ Methods:
 - <code title="get /api/v1/scenarios">client.v1.scenarios.<a href="./src/studyfetch_sdk/resources/v1/scenarios/scenarios.py">list</a>() -> None</code>
 - <code title="delete /api/v1/scenarios/{id}">client.v1.scenarios.<a href="./src/studyfetch_sdk/resources/v1/scenarios/scenarios.py">delete</a>(id) -> None</code>
 - <code title="get /api/v1/scenarios/{id}/stats">client.v1.scenarios.<a href="./src/studyfetch_sdk/resources/v1/scenarios/scenarios.py">get_stats</a>(id) -> None</code>
-- <code title="post /api/v1/scenarios/{id}/submit">client.v1.scenarios.<a href="./src/studyfetch_sdk/resources/v1/scenarios/scenarios.py">submit</a>(id, \*\*<a href="src/studyfetch_sdk/types/v1/scenario_submit_params.py">params</a>) -> None</code>
+- <code title="post /api/v1/scenarios/{id}/submit">client.v1.scenarios.<a href="./src/studyfetch_sdk/resources/v1/scenarios/scenarios.py">submit_answer</a>(id, \*\*<a href="src/studyfetch_sdk/types/v1/scenario_submit_answer_params.py">params</a>) -> None</code>
 
 ### Component
 
@@ -241,14 +231,15 @@ Methods:
 
 Methods:
 
-- <code title="get /api/v1/scenarios/{id}/submissions/user">client.v1.scenarios.submissions.user.<a href="./src/studyfetch_sdk/resources/v1/scenarios/submissions/user.py">retrieve</a>(id) -> None</code>
-- <code title="get /api/v1/scenarios/submissions/user">client.v1.scenarios.submissions.user.<a href="./src/studyfetch_sdk/resources/v1/scenarios/submissions/user.py">list</a>() -> None</code>
+- <code title="get /api/v1/scenarios/submissions/user">client.v1.scenarios.submissions.user.<a href="./src/studyfetch_sdk/resources/v1/scenarios/submissions/user.py">get_all</a>() -> None</code>
+- <code title="get /api/v1/scenarios/{id}/submissions/user">client.v1.scenarios.submissions.user.<a href="./src/studyfetch_sdk/resources/v1/scenarios/submissions/user.py">get_by_scenario</a>(id) -> None</code>
 
 ## Explainers
 
 Methods:
 
 - <code title="post /api/v1/explainers/create">client.v1.explainers.<a href="./src/studyfetch_sdk/resources/v1/explainers.py">create</a>(\*\*<a href="src/studyfetch_sdk/types/v1/explainer_create_params.py">params</a>) -> None</code>
+- <code title="get /api/v1/explainers/component/{componentId}">client.v1.explainers.<a href="./src/studyfetch_sdk/resources/v1/explainers.py">retrieve</a>(component_id) -> None</code>
 - <code title="post /api/v1/explainers/webhook">client.v1.explainers.<a href="./src/studyfetch_sdk/resources/v1/explainers.py">handle_webhook</a>(\*\*<a href="src/studyfetch_sdk/types/v1/explainer_handle_webhook_params.py">params</a>) -> None</code>
 
 ## Upload

{studyfetch_sdk-0.1.0a5 → studyfetch_sdk-0.1.0a6}/pyproject.toml

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

{studyfetch_sdk-0.1.0a5 → studyfetch_sdk-0.1.0a6}/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.5"  # x-release-please-version
+__version__ = "0.1.0-alpha.6"  # x-release-please-version

{studyfetch_sdk-0.1.0a5 → studyfetch_sdk-0.1.0a6}/src/studyfetch_sdk/resources/v1/chat/chat.py

@@ -25,7 +25,7 @@ from .sessions import (
 from ...._types import NOT_GIVEN, Body, Query, Headers, NoneType, NotGiven
 from ...._utils import maybe_transform, strip_not_given, async_maybe_transform
 from ...._compat import cached_property
-from ....types.v1 import chat_stream_params, chat_send_message_params, chat_retrieve_session_params
+from ....types.v1 import chat_stream_params, chat_get_session_params, chat_send_message_params
 from ...._resource import SyncAPIResource, AsyncAPIResource
 from ...._response import (
     to_raw_response_wrapper,
@@ -85,7 +85,7 @@ class ChatResource(SyncAPIResource):
             cast_to=NoneType,
         )
 
-    def retrieve_session(
+    def get_session(
         self,
         session_id: str,
         *,
@@ -117,7 +117,7 @@ class ChatResource(SyncAPIResource):
                 extra_query=extra_query,
                 extra_body=extra_body,
                 timeout=timeout,
-                query=maybe_transform({"user_id": user_id}, chat_retrieve_session_params.ChatRetrieveSessionParams),
+                query=maybe_transform({"user_id": user_id}, chat_get_session_params.ChatGetSessionParams),
             ),
             cast_to=NoneType,
         )
@@ -295,7 +295,7 @@ class AsyncChatResource(AsyncAPIResource):
             cast_to=NoneType,
         )
 
-    async def retrieve_session(
+    async def get_session(
         self,
         session_id: str,
         *,
@@ -327,9 +327,7 @@ class AsyncChatResource(AsyncAPIResource):
                 extra_query=extra_query,
                 extra_body=extra_body,
                 timeout=timeout,
-                query=await async_maybe_transform(
-                    {"user_id": user_id}, chat_retrieve_session_params.ChatRetrieveSessionParams
-                ),
+                query=await async_maybe_transform({"user_id": user_id}, chat_get_session_params.ChatGetSessionParams),
             ),
             cast_to=NoneType,
         )
@@ -467,8 +465,8 @@ class ChatResourceWithRawResponse:
         self.get_history = to_raw_response_wrapper(
             chat.get_history,
         )
-        self.retrieve_session = to_raw_response_wrapper(
-            chat.retrieve_session,
+        self.get_session = to_raw_response_wrapper(
+            chat.get_session,
         )
         self.send_followups = to_raw_response_wrapper(
             chat.send_followups,
@@ -496,8 +494,8 @@ class AsyncChatResourceWithRawResponse:
         self.get_history = async_to_raw_response_wrapper(
             chat.get_history,
         )
-        self.retrieve_session = async_to_raw_response_wrapper(
-            chat.retrieve_session,
+        self.get_session = async_to_raw_response_wrapper(
+            chat.get_session,
         )
         self.send_followups = async_to_raw_response_wrapper(
             chat.send_followups,
@@ -525,8 +523,8 @@ class ChatResourceWithStreamingResponse:
         self.get_history = to_streamed_response_wrapper(
             chat.get_history,
         )
-        self.retrieve_session = to_streamed_response_wrapper(
-            chat.retrieve_session,
+        self.get_session = to_streamed_response_wrapper(
+            chat.get_session,
         )
         self.send_followups = to_streamed_response_wrapper(
             chat.send_followups,
@@ -554,8 +552,8 @@ class AsyncChatResourceWithStreamingResponse:
         self.get_history = async_to_streamed_response_wrapper(
             chat.get_history,
         )
-        self.retrieve_session = async_to_streamed_response_wrapper(
-            chat.retrieve_session,
+        self.get_session = async_to_streamed_response_wrapper(
+            chat.get_session,
         )
         self.send_followups = async_to_streamed_response_wrapper(
             chat.send_followups,