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

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

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

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

@@ -1,5 +1,14 @@
 # Changelog
 
+## 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)
+
+### Features
+
+* **api:** api update ([d8de024](https://github.com/GoStudyFetchGo/studyfetch-sdk-python/commit/d8de02409dc5c0027546d86391f382e8fff0b40f))
+* **api:** api update ([6c6ed58](https://github.com/GoStudyFetchGo/studyfetch-sdk-python/commit/6c6ed585b134254c592300840bc4be4516f79c9f))
+
 ## 0.1.0-alpha.4 (2025-07-19)
 
 Full Changelog: [v0.1.0-alpha.3...v0.1.0-alpha.4](https://github.com/GoStudyFetchGo/studyfetch-sdk-python/compare/v0.1.0-alpha.3...v0.1.0-alpha.4)

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: studyfetch_sdk
-Version: 0.1.0a4
+Version: 0.1.0a5
 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

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

@@ -218,14 +218,14 @@ 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) -> 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>
 
 ### Component
 
 Methods:
 
 - <code title="get /api/v1/scenarios/component/{componentId}">client.v1.scenarios.component.<a href="./src/studyfetch_sdk/resources/v1/scenarios/component.py">retrieve</a>(component_id) -> None</code>
-- <code title="put /api/v1/scenarios/component/{componentId}">client.v1.scenarios.component.<a href="./src/studyfetch_sdk/resources/v1/scenarios/component.py">update</a>(component_id, \*\*<a href="src/studyfetch_sdk/types/v1/scenarios/component_update_params.py">params</a>) -> None</code>
+- <code title="put /api/v1/scenarios/component/{componentId}">client.v1.scenarios.component.<a href="./src/studyfetch_sdk/resources/v1/scenarios/component.py">update</a>(path_component_id, \*\*<a href="src/studyfetch_sdk/types/v1/scenarios/component_update_params.py">params</a>) -> None</code>
 - <code title="delete /api/v1/scenarios/component/{componentId}">client.v1.scenarios.component.<a href="./src/studyfetch_sdk/resources/v1/scenarios/component.py">delete</a>(component_id) -> None</code>
 
 ### Sessions
@@ -248,7 +248,7 @@ Methods:
 
 Methods:
 
-- <code title="post /api/v1/explainers/create">client.v1.explainers.<a href="./src/studyfetch_sdk/resources/v1/explainers.py">create</a>() -> None</code>
+- <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="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.0a4 → studyfetch_sdk-0.1.0a5}/pyproject.toml

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

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

{studyfetch_sdk-0.1.0a4 → studyfetch_sdk-0.1.0a5}/src/studyfetch_sdk/resources/v1/explainers.py

@@ -2,12 +2,15 @@
 
 from __future__ import annotations
 
+from typing import List
+from typing_extensions import Literal
+
 import httpx
 
 from ..._types import NOT_GIVEN, Body, Query, Headers, NoneType, NotGiven
 from ..._utils import maybe_transform, async_maybe_transform
 from ..._compat import cached_property
-from ...types.v1 import explainer_handle_webhook_params
+from ...types.v1 import explainer_create_params, explainer_handle_webhook_params
 from ..._resource import SyncAPIResource, AsyncAPIResource
 from ..._response import (
     to_raw_response_wrapper,
@@ -43,6 +46,17 @@ class ExplainersResource(SyncAPIResource):
     def create(
         self,
         *,
+        component_id: str,
+        folder_ids: List[str],
+        material_ids: List[str],
+        target_length: float,
+        title: str,
+        image_search: bool | NotGiven = NOT_GIVEN,
+        model: str | NotGiven = NOT_GIVEN,
+        style: str | NotGiven = NOT_GIVEN,
+        user_id: str | NotGiven = NOT_GIVEN,
+        vertical_video: bool | NotGiven = NOT_GIVEN,
+        web_search: bool | 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,
@@ -50,10 +64,59 @@ class ExplainersResource(SyncAPIResource):
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> None:
-        """Create explainers component"""
+        """
+        Create explainers component
+
+        Args:
+          component_id: Component ID
+
+          folder_ids: Folder IDs to include
+
+          material_ids: Material IDs to include
+
+          target_length: Target video length in seconds
+
+          title: Title for the explainer video
+
+          image_search: Enable image search for visuals
+
+          model: AI model to use
+
+          style: Video style
+
+          user_id: User ID
+
+          vertical_video: Create vertical video format (9:16)
+
+          web_search: Enable web search for additional content
+
+          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
+        """
         extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return self._post(
             "/api/v1/explainers/create",
+            body=maybe_transform(
+                {
+                    "component_id": component_id,
+                    "folder_ids": folder_ids,
+                    "material_ids": material_ids,
+                    "target_length": target_length,
+                    "title": title,
+                    "image_search": image_search,
+                    "model": model,
+                    "style": style,
+                    "user_id": user_id,
+                    "vertical_video": vertical_video,
+                    "web_search": web_search,
+                },
+                explainer_create_params.ExplainerCreateParams,
+            ),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -63,7 +126,8 @@ class ExplainersResource(SyncAPIResource):
     def handle_webhook(
         self,
         *,
-        body: str,
+        event: Literal["video.completed", "video.progress", "video.failed"],
+        video: explainer_handle_webhook_params.Video,
         # 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,
@@ -72,9 +136,13 @@ class ExplainersResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> None:
         """
-        Handle webhook events
+        Handle explainer video webhook events
 
         Args:
+          event: Webhook event type
+
+          video: Video data
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -86,7 +154,13 @@ class ExplainersResource(SyncAPIResource):
         extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return self._post(
             "/api/v1/explainers/webhook",
-            body=maybe_transform(body, explainer_handle_webhook_params.ExplainerHandleWebhookParams),
+            body=maybe_transform(
+                {
+                    "event": event,
+                    "video": video,
+                },
+                explainer_handle_webhook_params.ExplainerHandleWebhookParams,
+            ),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -117,6 +191,17 @@ class AsyncExplainersResource(AsyncAPIResource):
     async def create(
         self,
         *,
+        component_id: str,
+        folder_ids: List[str],
+        material_ids: List[str],
+        target_length: float,
+        title: str,
+        image_search: bool | NotGiven = NOT_GIVEN,
+        model: str | NotGiven = NOT_GIVEN,
+        style: str | NotGiven = NOT_GIVEN,
+        user_id: str | NotGiven = NOT_GIVEN,
+        vertical_video: bool | NotGiven = NOT_GIVEN,
+        web_search: bool | 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,
@@ -124,10 +209,59 @@ class AsyncExplainersResource(AsyncAPIResource):
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> None:
-        """Create explainers component"""
+        """
+        Create explainers component
+
+        Args:
+          component_id: Component ID
+
+          folder_ids: Folder IDs to include
+
+          material_ids: Material IDs to include
+
+          target_length: Target video length in seconds
+
+          title: Title for the explainer video
+
+          image_search: Enable image search for visuals
+
+          model: AI model to use
+
+          style: Video style
+
+          user_id: User ID
+
+          vertical_video: Create vertical video format (9:16)
+
+          web_search: Enable web search for additional content
+
+          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
+        """
         extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return await self._post(
             "/api/v1/explainers/create",
+            body=await async_maybe_transform(
+                {
+                    "component_id": component_id,
+                    "folder_ids": folder_ids,
+                    "material_ids": material_ids,
+                    "target_length": target_length,
+                    "title": title,
+                    "image_search": image_search,
+                    "model": model,
+                    "style": style,
+                    "user_id": user_id,
+                    "vertical_video": vertical_video,
+                    "web_search": web_search,
+                },
+                explainer_create_params.ExplainerCreateParams,
+            ),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -137,7 +271,8 @@ class AsyncExplainersResource(AsyncAPIResource):
     async def handle_webhook(
         self,
         *,
-        body: str,
+        event: Literal["video.completed", "video.progress", "video.failed"],
+        video: explainer_handle_webhook_params.Video,
         # 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,
@@ -146,9 +281,13 @@ class AsyncExplainersResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> None:
         """
-        Handle webhook events
+        Handle explainer video webhook events
 
         Args:
+          event: Webhook event type
+
+          video: Video data
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -160,7 +299,13 @@ class AsyncExplainersResource(AsyncAPIResource):
         extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return await self._post(
             "/api/v1/explainers/webhook",
-            body=await async_maybe_transform(body, explainer_handle_webhook_params.ExplainerHandleWebhookParams),
+            body=await async_maybe_transform(
+                {
+                    "event": event,
+                    "video": video,
+                },
+                explainer_handle_webhook_params.ExplainerHandleWebhookParams,
+            ),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),

{studyfetch_sdk-0.1.0a4 → studyfetch_sdk-0.1.0a5}/src/studyfetch_sdk/resources/v1/scenarios/component.py

@@ -2,6 +2,8 @@
 
 from __future__ import annotations
 
+from typing import Iterable
+
 import httpx
 
 from ...._types import NOT_GIVEN, Body, Query, Headers, NoneType, NotGiven
@@ -76,9 +78,20 @@ class ComponentResource(SyncAPIResource):
 
     def update(
         self,
-        component_id: str,
+        path_component_id: str,
         *,
-        body: str,
+        body_component_id: str,
+        name: str,
+        characters: Iterable[object] | NotGiven = NOT_GIVEN,
+        context: str | NotGiven = NOT_GIVEN,
+        description: str | NotGiven = NOT_GIVEN,
+        final_answer_prompt: str | NotGiven = NOT_GIVEN,
+        format: str | NotGiven = NOT_GIVEN,
+        goal: str | NotGiven = NOT_GIVEN,
+        greeting_character_id: str | NotGiven = NOT_GIVEN,
+        greeting_message: str | NotGiven = NOT_GIVEN,
+        requires_final_answer: bool | NotGiven = NOT_GIVEN,
+        tools: Iterable[object] | 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,
@@ -90,6 +103,30 @@ class ComponentResource(SyncAPIResource):
         Update scenario by component ID
 
         Args:
+          body_component_id: Associated component ID
+
+          name: Scenario name
+
+          characters: Scenario characters
+
+          context: Scenario context
+
+          description: Scenario description
+
+          final_answer_prompt: Prompt for final answer
+
+          format: Interaction format
+
+          goal: Scenario goal
+
+          greeting_character_id: Character ID for greeting
+
+          greeting_message: Greeting message
+
+          requires_final_answer: Whether scenario requires a final answer
+
+          tools: Available tools
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -98,12 +135,28 @@ class ComponentResource(SyncAPIResource):
 
           timeout: Override the client-level default timeout for this request, in seconds
         """
-        if not component_id:
-            raise ValueError(f"Expected a non-empty value for `component_id` but received {component_id!r}")
+        if not path_component_id:
+            raise ValueError(f"Expected a non-empty value for `path_component_id` but received {path_component_id!r}")
         extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return self._put(
-            f"/api/v1/scenarios/component/{component_id}",
-            body=maybe_transform(body, component_update_params.ComponentUpdateParams),
+            f"/api/v1/scenarios/component/{path_component_id}",
+            body=maybe_transform(
+                {
+                    "body_component_id": body_component_id,
+                    "name": name,
+                    "characters": characters,
+                    "context": context,
+                    "description": description,
+                    "final_answer_prompt": final_answer_prompt,
+                    "format": format,
+                    "goal": goal,
+                    "greeting_character_id": greeting_character_id,
+                    "greeting_message": greeting_message,
+                    "requires_final_answer": requires_final_answer,
+                    "tools": tools,
+                },
+                component_update_params.ComponentUpdateParams,
+            ),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -201,9 +254,20 @@ class AsyncComponentResource(AsyncAPIResource):
 
     async def update(
         self,
-        component_id: str,
+        path_component_id: str,
         *,
-        body: str,
+        body_component_id: str,
+        name: str,
+        characters: Iterable[object] | NotGiven = NOT_GIVEN,
+        context: str | NotGiven = NOT_GIVEN,
+        description: str | NotGiven = NOT_GIVEN,
+        final_answer_prompt: str | NotGiven = NOT_GIVEN,
+        format: str | NotGiven = NOT_GIVEN,
+        goal: str | NotGiven = NOT_GIVEN,
+        greeting_character_id: str | NotGiven = NOT_GIVEN,
+        greeting_message: str | NotGiven = NOT_GIVEN,
+        requires_final_answer: bool | NotGiven = NOT_GIVEN,
+        tools: Iterable[object] | 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,
@@ -215,6 +279,30 @@ class AsyncComponentResource(AsyncAPIResource):
         Update scenario by component ID
 
         Args:
+          body_component_id: Associated component ID
+
+          name: Scenario name
+
+          characters: Scenario characters
+
+          context: Scenario context
+
+          description: Scenario description
+
+          final_answer_prompt: Prompt for final answer
+
+          format: Interaction format
+
+          goal: Scenario goal
+
+          greeting_character_id: Character ID for greeting
+
+          greeting_message: Greeting message
+
+          requires_final_answer: Whether scenario requires a final answer
+
+          tools: Available tools
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -223,12 +311,28 @@ class AsyncComponentResource(AsyncAPIResource):
 
           timeout: Override the client-level default timeout for this request, in seconds
         """
-        if not component_id:
-            raise ValueError(f"Expected a non-empty value for `component_id` but received {component_id!r}")
+        if not path_component_id:
+            raise ValueError(f"Expected a non-empty value for `path_component_id` but received {path_component_id!r}")
         extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return await self._put(
-            f"/api/v1/scenarios/component/{component_id}",
-            body=await async_maybe_transform(body, component_update_params.ComponentUpdateParams),
+            f"/api/v1/scenarios/component/{path_component_id}",
+            body=await async_maybe_transform(
+                {
+                    "body_component_id": body_component_id,
+                    "name": name,
+                    "characters": characters,
+                    "context": context,
+                    "description": description,
+                    "final_answer_prompt": final_answer_prompt,
+                    "format": format,
+                    "goal": goal,
+                    "greeting_character_id": greeting_character_id,
+                    "greeting_message": greeting_message,
+                    "requires_final_answer": requires_final_answer,
+                    "tools": tools,
+                },
+                component_update_params.ComponentUpdateParams,
+            ),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),