studyfetch-sdk 0.1.0a4__py3-none-any.whl → 0.1.0a6__py3-none-any.whl

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,93 @@ 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
+            ),
+            cast_to=NoneType,
+        )
+
+    def retrieve(
+        self,
+        component_id: str,
+        *,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> None:
+        """
+        Get explainer video by component ID
+
+        Args:
+          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
+        """
+        if not component_id:
+            raise ValueError(f"Expected a non-empty value for `component_id` but received {component_id!r}")
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        return self._get(
+            f"/api/v1/explainers/component/{component_id}",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -63,7 +160,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 +170,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 +188,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 +225,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 +243,93 @@ 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
+            ),
+            cast_to=NoneType,
+        )
+
+    async def retrieve(
+        self,
+        component_id: str,
+        *,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> None:
+        """
+        Get explainer video by component ID
+
+        Args:
+          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
+        """
+        if not component_id:
+            raise ValueError(f"Expected a non-empty value for `component_id` but received {component_id!r}")
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        return await self._get(
+            f"/api/v1/explainers/component/{component_id}",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -137,7 +339,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 +349,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 +367,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
             ),
@@ -175,6 +388,9 @@ class ExplainersResourceWithRawResponse:
         self.create = to_raw_response_wrapper(
             explainers.create,
         )
+        self.retrieve = to_raw_response_wrapper(
+            explainers.retrieve,
+        )
         self.handle_webhook = to_raw_response_wrapper(
             explainers.handle_webhook,
         )
@@ -187,6 +403,9 @@ class AsyncExplainersResourceWithRawResponse:
         self.create = async_to_raw_response_wrapper(
             explainers.create,
         )
+        self.retrieve = async_to_raw_response_wrapper(
+            explainers.retrieve,
+        )
         self.handle_webhook = async_to_raw_response_wrapper(
             explainers.handle_webhook,
         )
@@ -199,6 +418,9 @@ class ExplainersResourceWithStreamingResponse:
         self.create = to_streamed_response_wrapper(
             explainers.create,
         )
+        self.retrieve = to_streamed_response_wrapper(
+            explainers.retrieve,
+        )
         self.handle_webhook = to_streamed_response_wrapper(
             explainers.handle_webhook,
         )
@@ -211,6 +433,9 @@ class AsyncExplainersResourceWithStreamingResponse:
         self.create = async_to_streamed_response_wrapper(
             explainers.create,
         )
+        self.retrieve = async_to_streamed_response_wrapper(
+            explainers.retrieve,
+        )
         self.handle_webhook = async_to_streamed_response_wrapper(
             explainers.handle_webhook,
         )

studyfetch_sdk/resources/v1/flashcards.py

@@ -26,7 +26,7 @@ from ..._response import (
 from ..._base_client import make_request_options
 from ...types.v1.flashcard_get_types_response import FlashcardGetTypesResponse
 from ...types.v1.flashcard_batch_process_response import FlashcardBatchProcessResponse
-from ...types.v1.flashcard_get_algorithm_info_response import FlashcardGetAlgorithmInfoResponse
+from ...types.v1.flashcard_get_algorithm_response import FlashcardGetAlgorithmResponse
 
 __all__ = ["FlashcardsResource", "AsyncFlashcardsResource"]
 
@@ -99,7 +99,7 @@ class FlashcardsResource(SyncAPIResource):
             cast_to=FlashcardBatchProcessResponse,
         )
 
-    def get_algorithm_info(
+    def get_algorithm(
         self,
         *,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -108,14 +108,14 @@ class FlashcardsResource(SyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> FlashcardGetAlgorithmInfoResponse:
+    ) -> FlashcardGetAlgorithmResponse:
         """Get spaced repetition algorithm info"""
         return self._get(
             "/api/v1/flashcards/algorithm",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=FlashcardGetAlgorithmInfoResponse,
+            cast_to=FlashcardGetAlgorithmResponse,
         )
 
     def get_all(
@@ -421,7 +421,7 @@ class AsyncFlashcardsResource(AsyncAPIResource):
             cast_to=FlashcardBatchProcessResponse,
         )
 
-    async def get_algorithm_info(
+    async def get_algorithm(
         self,
         *,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -430,14 +430,14 @@ class AsyncFlashcardsResource(AsyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> FlashcardGetAlgorithmInfoResponse:
+    ) -> FlashcardGetAlgorithmResponse:
         """Get spaced repetition algorithm info"""
         return await self._get(
             "/api/v1/flashcards/algorithm",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=FlashcardGetAlgorithmInfoResponse,
+            cast_to=FlashcardGetAlgorithmResponse,
         )
 
     async def get_all(
@@ -682,8 +682,8 @@ class FlashcardsResourceWithRawResponse:
         self.batch_process = to_raw_response_wrapper(
             flashcards.batch_process,
         )
-        self.get_algorithm_info = to_raw_response_wrapper(
-            flashcards.get_algorithm_info,
+        self.get_algorithm = to_raw_response_wrapper(
+            flashcards.get_algorithm,
         )
         self.get_all = to_raw_response_wrapper(
             flashcards.get_all,
@@ -709,8 +709,8 @@ class AsyncFlashcardsResourceWithRawResponse:
         self.batch_process = async_to_raw_response_wrapper(
             flashcards.batch_process,
         )
-        self.get_algorithm_info = async_to_raw_response_wrapper(
-            flashcards.get_algorithm_info,
+        self.get_algorithm = async_to_raw_response_wrapper(
+            flashcards.get_algorithm,
         )
         self.get_all = async_to_raw_response_wrapper(
             flashcards.get_all,
@@ -736,8 +736,8 @@ class FlashcardsResourceWithStreamingResponse:
         self.batch_process = to_streamed_response_wrapper(
             flashcards.batch_process,
         )
-        self.get_algorithm_info = to_streamed_response_wrapper(
-            flashcards.get_algorithm_info,
+        self.get_algorithm = to_streamed_response_wrapper(
+            flashcards.get_algorithm,
         )
         self.get_all = to_streamed_response_wrapper(
             flashcards.get_all,
@@ -763,8 +763,8 @@ class AsyncFlashcardsResourceWithStreamingResponse:
         self.batch_process = async_to_streamed_response_wrapper(
             flashcards.batch_process,
         )
-        self.get_algorithm_info = async_to_streamed_response_wrapper(
-            flashcards.get_algorithm_info,
+        self.get_algorithm = async_to_streamed_response_wrapper(
+            flashcards.get_algorithm,
         )
         self.get_all = async_to_streamed_response_wrapper(
             flashcards.get_all,

studyfetch_sdk/resources/v1/materials/materials.py

@@ -40,9 +40,8 @@ from ...._response import (
     async_to_streamed_response_wrapper,
 )
 from ...._base_client import make_request_options
+from ....types.v1.material import Material
 from ....types.v1.material_list_response import MaterialListResponse
-from ....types.v1.material_create_response import MaterialCreateResponse
-from ....types.v1.material_retrieve_response import MaterialRetrieveResponse
 
 __all__ = ["MaterialsResource", "AsyncMaterialsResource"]
 
@@ -91,7 +90,7 @@ class MaterialsResource(SyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> MaterialCreateResponse:
+    ) -> Material:
         """
         Create a new material
 
@@ -123,7 +122,7 @@ class MaterialsResource(SyncAPIResource):
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=MaterialCreateResponse,
+            cast_to=Material,
         )
 
     def retrieve(
@@ -136,7 +135,7 @@ class MaterialsResource(SyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> MaterialRetrieveResponse:
+    ) -> Material:
         """
         Get material by ID
 
@@ -156,7 +155,7 @@ class MaterialsResource(SyncAPIResource):
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=MaterialRetrieveResponse,
+            cast_to=Material,
         )
 
     def list(
@@ -230,7 +229,7 @@ class MaterialsResource(SyncAPIResource):
             cast_to=NoneType,
         )
 
-    def create_batch(
+    def batch_create(
         self,
         *,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -480,7 +479,7 @@ class AsyncMaterialsResource(AsyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> MaterialCreateResponse:
+    ) -> Material:
         """
         Create a new material
 
@@ -512,7 +511,7 @@ class AsyncMaterialsResource(AsyncAPIResource):
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=MaterialCreateResponse,
+            cast_to=Material,
         )
 
     async def retrieve(
@@ -525,7 +524,7 @@ class AsyncMaterialsResource(AsyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> MaterialRetrieveResponse:
+    ) -> Material:
         """
         Get material by ID
 
@@ -545,7 +544,7 @@ class AsyncMaterialsResource(AsyncAPIResource):
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=MaterialRetrieveResponse,
+            cast_to=Material,
         )
 
     async def list(
@@ -619,7 +618,7 @@ class AsyncMaterialsResource(AsyncAPIResource):
             cast_to=NoneType,
         )
 
-    async def create_batch(
+    async def batch_create(
         self,
         *,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -841,8 +840,8 @@ class MaterialsResourceWithRawResponse:
         self.delete = to_raw_response_wrapper(
             materials.delete,
         )
-        self.create_batch = to_raw_response_wrapper(
-            materials.create_batch,
+        self.batch_create = to_raw_response_wrapper(
+            materials.batch_create,
         )
         self.debug = to_raw_response_wrapper(
             materials.debug,
@@ -892,8 +891,8 @@ class AsyncMaterialsResourceWithRawResponse:
         self.delete = async_to_raw_response_wrapper(
             materials.delete,
         )
-        self.create_batch = async_to_raw_response_wrapper(
-            materials.create_batch,
+        self.batch_create = async_to_raw_response_wrapper(
+            materials.batch_create,
         )
         self.debug = async_to_raw_response_wrapper(
             materials.debug,
@@ -943,8 +942,8 @@ class MaterialsResourceWithStreamingResponse:
         self.delete = to_streamed_response_wrapper(
             materials.delete,
         )
-        self.create_batch = to_streamed_response_wrapper(
-            materials.create_batch,
+        self.batch_create = to_streamed_response_wrapper(
+            materials.batch_create,
         )
         self.debug = to_streamed_response_wrapper(
             materials.debug,
@@ -994,8 +993,8 @@ class AsyncMaterialsResourceWithStreamingResponse:
         self.delete = async_to_streamed_response_wrapper(
             materials.delete,
         )
-        self.create_batch = async_to_streamed_response_wrapper(
-            materials.create_batch,
+        self.batch_create = async_to_streamed_response_wrapper(
+            materials.batch_create,
         )
         self.debug = async_to_streamed_response_wrapper(
             materials.debug,