studyfetch-sdk 0.1.0a3__py3-none-any.whl → 0.1.0a5__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.3"  # x-release-please-version
+__version__ = "0.1.0-alpha.5"  # x-release-please-version

studyfetch_sdk/resources/v1/chat/chat.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import Iterable
+from typing import List, Iterable
 
 import httpx
 
@@ -148,7 +148,7 @@ class ChatResource(SyncAPIResource):
         message: chat_send_message_params.Message,
         x_component_id: str,
         context: object | NotGiven = NOT_GIVEN,
-        group_id: str | NotGiven = NOT_GIVEN,
+        group_ids: List[str] | NotGiven = NOT_GIVEN,
         session_id: str | NotGiven = NOT_GIVEN,
         user_id: str | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -166,7 +166,7 @@ class ChatResource(SyncAPIResource):
 
           context: Additional context data
 
-          group_id: Group ID for collaboration
+          group_ids: Group IDs for collaboration
 
           session_id: Session ID for conversation continuity
 
@@ -189,7 +189,7 @@ class ChatResource(SyncAPIResource):
                     "component_id": component_id,
                     "message": message,
                     "context": context,
-                    "group_id": group_id,
+                    "group_ids": group_ids,
                     "session_id": session_id,
                     "user_id": user_id,
                 },
@@ -360,7 +360,7 @@ class AsyncChatResource(AsyncAPIResource):
         message: chat_send_message_params.Message,
         x_component_id: str,
         context: object | NotGiven = NOT_GIVEN,
-        group_id: str | NotGiven = NOT_GIVEN,
+        group_ids: List[str] | NotGiven = NOT_GIVEN,
         session_id: str | NotGiven = NOT_GIVEN,
         user_id: str | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -378,7 +378,7 @@ class AsyncChatResource(AsyncAPIResource):
 
           context: Additional context data
 
-          group_id: Group ID for collaboration
+          group_ids: Group IDs for collaboration
 
           session_id: Session ID for conversation continuity
 
@@ -401,7 +401,7 @@ class AsyncChatResource(AsyncAPIResource):
                     "component_id": component_id,
                     "message": message,
                     "context": context,
-                    "group_id": group_id,
+                    "group_ids": group_ids,
                     "session_id": session_id,
                     "user_id": user_id,
                 },

studyfetch_sdk/resources/v1/components.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 
+from typing import List
 from typing_extensions import Literal
 
 import httpx
@@ -50,7 +51,7 @@ class ComponentsResource(SyncAPIResource):
     def create(
         self,
         *,
-        config: object,
+        config: component_create_params.Config,
         name: str,
         origin: Literal["chat", "classroom", "upload", "console", "api"],
         type: Literal[
@@ -322,7 +323,7 @@ class ComponentsResource(SyncAPIResource):
         *,
         expiry_hours: float | NotGiven = NOT_GIVEN,
         features: component_embed_params.Features | NotGiven = NOT_GIVEN,
-        group_id: str | NotGiven = NOT_GIVEN,
+        group_ids: List[str] | NotGiven = NOT_GIVEN,
         height: str | NotGiven = NOT_GIVEN,
         session_id: str | NotGiven = NOT_GIVEN,
         theme: component_embed_params.Theme | NotGiven = NOT_GIVEN,
@@ -343,7 +344,7 @@ class ComponentsResource(SyncAPIResource):
 
           features: Feature toggles
 
-          group_id: Group ID for collaboration
+          group_ids: Group IDs for collaboration
 
           height: Embed height (e.g., "400px", "100vh")
 
@@ -371,7 +372,7 @@ class ComponentsResource(SyncAPIResource):
                 {
                     "expiry_hours": expiry_hours,
                     "features": features,
-                    "group_id": group_id,
+                    "group_ids": group_ids,
                     "height": height,
                     "session_id": session_id,
                     "theme": theme,
@@ -442,7 +443,7 @@ class AsyncComponentsResource(AsyncAPIResource):
     async def create(
         self,
         *,
-        config: object,
+        config: component_create_params.Config,
         name: str,
         origin: Literal["chat", "classroom", "upload", "console", "api"],
         type: Literal[
@@ -714,7 +715,7 @@ class AsyncComponentsResource(AsyncAPIResource):
         *,
         expiry_hours: float | NotGiven = NOT_GIVEN,
         features: component_embed_params.Features | NotGiven = NOT_GIVEN,
-        group_id: str | NotGiven = NOT_GIVEN,
+        group_ids: List[str] | NotGiven = NOT_GIVEN,
         height: str | NotGiven = NOT_GIVEN,
         session_id: str | NotGiven = NOT_GIVEN,
         theme: component_embed_params.Theme | NotGiven = NOT_GIVEN,
@@ -735,7 +736,7 @@ class AsyncComponentsResource(AsyncAPIResource):
 
           features: Feature toggles
 
-          group_id: Group ID for collaboration
+          group_ids: Group IDs for collaboration
 
           height: Embed height (e.g., "400px", "100vh")
 
@@ -763,7 +764,7 @@ class AsyncComponentsResource(AsyncAPIResource):
                 {
                     "expiry_hours": expiry_hours,
                     "features": features,
-                    "group_id": group_id,
+                    "group_ids": group_ids,
                     "height": height,
                     "session_id": session_id,
                     "theme": theme,

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/resources/v1/flashcards.py

@@ -122,7 +122,7 @@ class FlashcardsResource(SyncAPIResource):
         self,
         component_id: str,
         *,
-        group_id: str | NotGiven = NOT_GIVEN,
+        group_ids: str | NotGiven = NOT_GIVEN,
         limit: float | NotGiven = NOT_GIVEN,
         offset: float | NotGiven = NOT_GIVEN,
         user_id: str | NotGiven = NOT_GIVEN,
@@ -137,7 +137,7 @@ class FlashcardsResource(SyncAPIResource):
         Get all flashcards for component
 
         Args:
-          group_id: Group ID
+          group_ids: Group IDs (comma-separated)
 
           limit: Max number of cards
 
@@ -165,7 +165,7 @@ class FlashcardsResource(SyncAPIResource):
                 timeout=timeout,
                 query=maybe_transform(
                     {
-                        "group_id": group_id,
+                        "group_ids": group_ids,
                         "limit": limit,
                         "offset": offset,
                         "user_id": user_id,
@@ -180,7 +180,7 @@ class FlashcardsResource(SyncAPIResource):
         self,
         component_id: str,
         *,
-        group_id: str,
+        group_ids: str,
         limit: float | NotGiven = NOT_GIVEN,
         user_id: str | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -218,7 +218,7 @@ class FlashcardsResource(SyncAPIResource):
                 timeout=timeout,
                 query=maybe_transform(
                     {
-                        "group_id": group_id,
+                        "group_ids": group_ids,
                         "limit": limit,
                         "user_id": user_id,
                     },
@@ -232,7 +232,7 @@ class FlashcardsResource(SyncAPIResource):
         self,
         component_id: str,
         *,
-        group_id: str | NotGiven = NOT_GIVEN,
+        group_ids: str | NotGiven = NOT_GIVEN,
         user_id: str | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
@@ -245,7 +245,7 @@ class FlashcardsResource(SyncAPIResource):
         Get flashcard statistics
 
         Args:
-          group_id: Group ID
+          group_ids: Group IDs (comma-separated)
 
           user_id: User ID
 
@@ -269,7 +269,7 @@ class FlashcardsResource(SyncAPIResource):
                 timeout=timeout,
                 query=maybe_transform(
                     {
-                        "group_id": group_id,
+                        "group_ids": group_ids,
                         "user_id": user_id,
                     },
                     flashcard_get_stats_params.FlashcardGetStatsParams,
@@ -444,7 +444,7 @@ class AsyncFlashcardsResource(AsyncAPIResource):
         self,
         component_id: str,
         *,
-        group_id: str | NotGiven = NOT_GIVEN,
+        group_ids: str | NotGiven = NOT_GIVEN,
         limit: float | NotGiven = NOT_GIVEN,
         offset: float | NotGiven = NOT_GIVEN,
         user_id: str | NotGiven = NOT_GIVEN,
@@ -459,7 +459,7 @@ class AsyncFlashcardsResource(AsyncAPIResource):
         Get all flashcards for component
 
         Args:
-          group_id: Group ID
+          group_ids: Group IDs (comma-separated)
 
           limit: Max number of cards
 
@@ -487,7 +487,7 @@ class AsyncFlashcardsResource(AsyncAPIResource):
                 timeout=timeout,
                 query=await async_maybe_transform(
                     {
-                        "group_id": group_id,
+                        "group_ids": group_ids,
                         "limit": limit,
                         "offset": offset,
                         "user_id": user_id,
@@ -502,7 +502,7 @@ class AsyncFlashcardsResource(AsyncAPIResource):
         self,
         component_id: str,
         *,
-        group_id: str,
+        group_ids: str,
         limit: float | NotGiven = NOT_GIVEN,
         user_id: str | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -540,7 +540,7 @@ class AsyncFlashcardsResource(AsyncAPIResource):
                 timeout=timeout,
                 query=await async_maybe_transform(
                     {
-                        "group_id": group_id,
+                        "group_ids": group_ids,
                         "limit": limit,
                         "user_id": user_id,
                     },
@@ -554,7 +554,7 @@ class AsyncFlashcardsResource(AsyncAPIResource):
         self,
         component_id: str,
         *,
-        group_id: str | NotGiven = NOT_GIVEN,
+        group_ids: str | NotGiven = NOT_GIVEN,
         user_id: str | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
@@ -567,7 +567,7 @@ class AsyncFlashcardsResource(AsyncAPIResource):
         Get flashcard statistics
 
         Args:
-          group_id: Group ID
+          group_ids: Group IDs (comma-separated)
 
           user_id: User ID
 
@@ -591,7 +591,7 @@ class AsyncFlashcardsResource(AsyncAPIResource):
                 timeout=timeout,
                 query=await async_maybe_transform(
                     {
-                        "group_id": group_id,
+                        "group_ids": group_ids,
                         "user_id": user_id,
                     },
                     flashcard_get_stats_params.FlashcardGetStatsParams,