studyfetch-sdk 0.1.0a19__py3-none-any.whl → 0.1.0a21__py3-none-any.whl

studyfetch_sdk/resources/v1/materials/materials.py

@@ -3,6 +3,7 @@
 from __future__ import annotations
 
 from typing import List, Iterable, Optional
+from typing_extensions import Literal
 
 import httpx
 
@@ -39,9 +40,11 @@ from ....types.v1 import (
     material_create_params,
     material_rename_params,
     material_search_params,
+    material_generate_params,
     material_batch_create_params,
     material_get_download_url_params,
     material_create_and_process_params,
+    material_generate_and_process_params,
 )
 from ...._resource import SyncAPIResource, AsyncAPIResource
 from ...._response import (
@@ -53,6 +56,7 @@ from ...._response import (
 from ...._base_client import make_request_options
 from ....types.v1.material import Material
 from ....types.v1.content_param import ContentParam
+from ....types.v1.generated_material import GeneratedMaterial
 from ....types.v1.material_list_response import MaterialListResponse
 from ....types.v1.material_debug_response import MaterialDebugResponse
 from ....types.v1.material_search_response import MaterialSearchResponse
@@ -369,6 +373,144 @@ class MaterialsResource(SyncAPIResource):
             cast_to=MaterialDebugResponse,
         )
 
+    def generate(
+        self,
+        *,
+        name: str,
+        topic: str,
+        type: Literal["outline", "overview", "notes", "summary"],
+        context: str | NotGiven = NOT_GIVEN,
+        folder_id: str | NotGiven = NOT_GIVEN,
+        length: Literal["short", "medium", "long"] | NotGiven = NOT_GIVEN,
+        level: Literal["high_school", "college", "professional"] | 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,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> GeneratedMaterial:
+        """Uses AI to generate study materials like outlines, notes, summaries, etc.
+
+        from a
+        given topic. Returns immediately without waiting for processing.
+
+        Args:
+          name: Name for the generated material
+
+          topic: Topic or context to generate material from
+
+          type: Type of material to generate
+
+          context: Additional context or details about the topic
+
+          folder_id: Target folder ID
+
+          length: Length of the generated content
+
+          level: Target education level
+
+          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
+        """
+        return self._post(
+            "/api/v1/materials/generate",
+            body=maybe_transform(
+                {
+                    "name": name,
+                    "topic": topic,
+                    "type": type,
+                    "context": context,
+                    "folder_id": folder_id,
+                    "length": length,
+                    "level": level,
+                },
+                material_generate_params.MaterialGenerateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=GeneratedMaterial,
+        )
+
+    def generate_and_process(
+        self,
+        *,
+        name: str,
+        topic: str,
+        type: Literal["outline", "overview", "notes", "summary"],
+        context: str | NotGiven = NOT_GIVEN,
+        folder_id: str | NotGiven = NOT_GIVEN,
+        length: Literal["short", "medium", "long"] | NotGiven = NOT_GIVEN,
+        level: Literal["high_school", "college", "professional"] | NotGiven = NOT_GIVEN,
+        poll_interval_ms: float | NotGiven = NOT_GIVEN,
+        timeout_ms: float | 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,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> GeneratedMaterial:
+        """Uses AI to generate study materials like outlines, notes, summaries, etc.
+
+        from a
+        given topic and waits for processing to complete
+
+        Args:
+          name: Name for the generated material
+
+          topic: Topic or context to generate material from
+
+          type: Type of material to generate
+
+          context: Additional context or details about the topic
+
+          folder_id: Target folder ID
+
+          length: Length of the generated content
+
+          level: Target education level
+
+          poll_interval_ms: Polling interval in milliseconds (default: 2 seconds)
+
+          timeout_ms: Maximum time to wait for processing in milliseconds (default: 5 minutes)
+
+          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
+        """
+        return self._post(
+            "/api/v1/materials/generate-and-process",
+            body=maybe_transform(
+                {
+                    "name": name,
+                    "topic": topic,
+                    "type": type,
+                    "context": context,
+                    "folder_id": folder_id,
+                    "length": length,
+                    "level": level,
+                    "poll_interval_ms": poll_interval_ms,
+                    "timeout_ms": timeout_ms,
+                },
+                material_generate_and_process_params.MaterialGenerateAndProcessParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=GeneratedMaterial,
+        )
+
     def get_download_url(
         self,
         id: str,
@@ -879,6 +1021,144 @@ class AsyncMaterialsResource(AsyncAPIResource):
             cast_to=MaterialDebugResponse,
         )
 
+    async def generate(
+        self,
+        *,
+        name: str,
+        topic: str,
+        type: Literal["outline", "overview", "notes", "summary"],
+        context: str | NotGiven = NOT_GIVEN,
+        folder_id: str | NotGiven = NOT_GIVEN,
+        length: Literal["short", "medium", "long"] | NotGiven = NOT_GIVEN,
+        level: Literal["high_school", "college", "professional"] | 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,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> GeneratedMaterial:
+        """Uses AI to generate study materials like outlines, notes, summaries, etc.
+
+        from a
+        given topic. Returns immediately without waiting for processing.
+
+        Args:
+          name: Name for the generated material
+
+          topic: Topic or context to generate material from
+
+          type: Type of material to generate
+
+          context: Additional context or details about the topic
+
+          folder_id: Target folder ID
+
+          length: Length of the generated content
+
+          level: Target education level
+
+          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
+        """
+        return await self._post(
+            "/api/v1/materials/generate",
+            body=await async_maybe_transform(
+                {
+                    "name": name,
+                    "topic": topic,
+                    "type": type,
+                    "context": context,
+                    "folder_id": folder_id,
+                    "length": length,
+                    "level": level,
+                },
+                material_generate_params.MaterialGenerateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=GeneratedMaterial,
+        )
+
+    async def generate_and_process(
+        self,
+        *,
+        name: str,
+        topic: str,
+        type: Literal["outline", "overview", "notes", "summary"],
+        context: str | NotGiven = NOT_GIVEN,
+        folder_id: str | NotGiven = NOT_GIVEN,
+        length: Literal["short", "medium", "long"] | NotGiven = NOT_GIVEN,
+        level: Literal["high_school", "college", "professional"] | NotGiven = NOT_GIVEN,
+        poll_interval_ms: float | NotGiven = NOT_GIVEN,
+        timeout_ms: float | 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,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> GeneratedMaterial:
+        """Uses AI to generate study materials like outlines, notes, summaries, etc.
+
+        from a
+        given topic and waits for processing to complete
+
+        Args:
+          name: Name for the generated material
+
+          topic: Topic or context to generate material from
+
+          type: Type of material to generate
+
+          context: Additional context or details about the topic
+
+          folder_id: Target folder ID
+
+          length: Length of the generated content
+
+          level: Target education level
+
+          poll_interval_ms: Polling interval in milliseconds (default: 2 seconds)
+
+          timeout_ms: Maximum time to wait for processing in milliseconds (default: 5 minutes)
+
+          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
+        """
+        return await self._post(
+            "/api/v1/materials/generate-and-process",
+            body=await async_maybe_transform(
+                {
+                    "name": name,
+                    "topic": topic,
+                    "type": type,
+                    "context": context,
+                    "folder_id": folder_id,
+                    "length": length,
+                    "level": level,
+                    "poll_interval_ms": poll_interval_ms,
+                    "timeout_ms": timeout_ms,
+                },
+                material_generate_and_process_params.MaterialGenerateAndProcessParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=GeneratedMaterial,
+        )
+
     async def get_download_url(
         self,
         id: str,
@@ -1105,6 +1385,12 @@ class MaterialsResourceWithRawResponse:
         self.debug = to_raw_response_wrapper(
             materials.debug,
         )
+        self.generate = to_raw_response_wrapper(
+            materials.generate,
+        )
+        self.generate_and_process = to_raw_response_wrapper(
+            materials.generate_and_process,
+        )
         self.get_download_url = to_raw_response_wrapper(
             materials.get_download_url,
         )
@@ -1159,6 +1445,12 @@ class AsyncMaterialsResourceWithRawResponse:
         self.debug = async_to_raw_response_wrapper(
             materials.debug,
         )
+        self.generate = async_to_raw_response_wrapper(
+            materials.generate,
+        )
+        self.generate_and_process = async_to_raw_response_wrapper(
+            materials.generate_and_process,
+        )
         self.get_download_url = async_to_raw_response_wrapper(
             materials.get_download_url,
         )
@@ -1213,6 +1505,12 @@ class MaterialsResourceWithStreamingResponse:
         self.debug = to_streamed_response_wrapper(
             materials.debug,
         )
+        self.generate = to_streamed_response_wrapper(
+            materials.generate,
+        )
+        self.generate_and_process = to_streamed_response_wrapper(
+            materials.generate_and_process,
+        )
         self.get_download_url = to_streamed_response_wrapper(
             materials.get_download_url,
         )
@@ -1267,6 +1565,12 @@ class AsyncMaterialsResourceWithStreamingResponse:
         self.debug = async_to_streamed_response_wrapper(
             materials.debug,
         )
+        self.generate = async_to_streamed_response_wrapper(
+            materials.generate,
+        )
+        self.generate_and_process = async_to_streamed_response_wrapper(
+            materials.generate_and_process,
+        )
         self.get_download_url = async_to_streamed_response_wrapper(
             materials.get_download_url,
         )

studyfetch_sdk/resources/v1/materials/upload.py

@@ -55,7 +55,6 @@ class UploadResource(SyncAPIResource):
         self,
         *,
         material_id: str,
-        organization_id: str,
         s3_key: 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.
@@ -68,11 +67,9 @@ class UploadResource(SyncAPIResource):
         Complete upload after using presigned URL
 
         Args:
-          material_id: The ID of the material that was uploaded
+          material_id: Material ID from presigned URL response
 
-          organization_id: The ID of the organization
-
-          s3_key: The S3 key of the uploaded file
+          s3_key: S3 key from presigned URL response
 
           extra_headers: Send extra headers
 
@@ -87,7 +84,6 @@ class UploadResource(SyncAPIResource):
             body=maybe_transform(
                 {
                     "material_id": material_id,
-                    "organization_id": organization_id,
                     "s3_key": s3_key,
                 },
                 upload_complete_upload_params.UploadCompleteUploadParams,
@@ -104,6 +100,7 @@ class UploadResource(SyncAPIResource):
         content_type: str,
         filename: str,
         name: str,
+        extract_images: bool | NotGiven = NOT_GIVEN,
         folder_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.
@@ -122,6 +119,8 @@ class UploadResource(SyncAPIResource):
 
           name: Display name for the material
 
+          extract_images: Whether to extract images from files
+
           folder_id: Folder ID to place the material in
 
           extra_headers: Send extra headers
@@ -139,6 +138,7 @@ class UploadResource(SyncAPIResource):
                     "content_type": content_type,
                     "filename": filename,
                     "name": name,
+                    "extract_images": extract_images,
                     "folder_id": folder_id,
                 },
                 upload_create_presigned_url_params.UploadCreatePresignedURLParams,
@@ -154,6 +154,7 @@ class UploadResource(SyncAPIResource):
         *,
         file: FileTypes,
         name: str,
+        extract_images: str | NotGiven = NOT_GIVEN,
         folder_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.
@@ -168,6 +169,8 @@ class UploadResource(SyncAPIResource):
         Args:
           name: Material name
 
+          extract_images: Whether to extract images from files (true/false, default: true)
+
           folder_id: Folder ID (optional)
 
           extra_headers: Send extra headers
@@ -182,6 +185,7 @@ class UploadResource(SyncAPIResource):
             {
                 "file": file,
                 "name": name,
+                "extract_images": extract_images,
                 "folder_id": folder_id,
             }
         )
@@ -205,6 +209,7 @@ class UploadResource(SyncAPIResource):
         *,
         file: FileTypes,
         name: str,
+        extract_images: str | NotGiven = NOT_GIVEN,
         folder_id: str | NotGiven = NOT_GIVEN,
         poll_interval_ms: float | NotGiven = NOT_GIVEN,
         timeout_ms: float | NotGiven = NOT_GIVEN,
@@ -223,11 +228,13 @@ class UploadResource(SyncAPIResource):
         Args:
           name: Material name
 
+          extract_images: Whether to extract images from files (true/false, default: true)
+
           folder_id: Folder ID (optional)
 
           poll_interval_ms: Polling interval in milliseconds (default: 2000)
 
-          timeout_ms: Processing timeout in milliseconds (default: 300000)
+          timeout_ms: Processing timeout in milliseconds (default: 300000 - 5 minutes)
 
           extra_headers: Send extra headers
 
@@ -241,6 +248,7 @@ class UploadResource(SyncAPIResource):
             {
                 "file": file,
                 "name": name,
+                "extract_images": extract_images,
                 "folder_id": folder_id,
                 "poll_interval_ms": poll_interval_ms,
                 "timeout_ms": timeout_ms,
@@ -389,7 +397,6 @@ class AsyncUploadResource(AsyncAPIResource):
         self,
         *,
         material_id: str,
-        organization_id: str,
         s3_key: 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.
@@ -402,11 +409,9 @@ class AsyncUploadResource(AsyncAPIResource):
         Complete upload after using presigned URL
 
         Args:
-          material_id: The ID of the material that was uploaded
+          material_id: Material ID from presigned URL response
 
-          organization_id: The ID of the organization
-
-          s3_key: The S3 key of the uploaded file
+          s3_key: S3 key from presigned URL response
 
           extra_headers: Send extra headers
 
@@ -421,7 +426,6 @@ class AsyncUploadResource(AsyncAPIResource):
             body=await async_maybe_transform(
                 {
                     "material_id": material_id,
-                    "organization_id": organization_id,
                     "s3_key": s3_key,
                 },
                 upload_complete_upload_params.UploadCompleteUploadParams,
@@ -438,6 +442,7 @@ class AsyncUploadResource(AsyncAPIResource):
         content_type: str,
         filename: str,
         name: str,
+        extract_images: bool | NotGiven = NOT_GIVEN,
         folder_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.
@@ -456,6 +461,8 @@ class AsyncUploadResource(AsyncAPIResource):
 
           name: Display name for the material
 
+          extract_images: Whether to extract images from files
+
           folder_id: Folder ID to place the material in
 
           extra_headers: Send extra headers
@@ -473,6 +480,7 @@ class AsyncUploadResource(AsyncAPIResource):
                     "content_type": content_type,
                     "filename": filename,
                     "name": name,
+                    "extract_images": extract_images,
                     "folder_id": folder_id,
                 },
                 upload_create_presigned_url_params.UploadCreatePresignedURLParams,
@@ -488,6 +496,7 @@ class AsyncUploadResource(AsyncAPIResource):
         *,
         file: FileTypes,
         name: str,
+        extract_images: str | NotGiven = NOT_GIVEN,
         folder_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.
@@ -502,6 +511,8 @@ class AsyncUploadResource(AsyncAPIResource):
         Args:
           name: Material name
 
+          extract_images: Whether to extract images from files (true/false, default: true)
+
           folder_id: Folder ID (optional)
 
           extra_headers: Send extra headers
@@ -516,6 +527,7 @@ class AsyncUploadResource(AsyncAPIResource):
             {
                 "file": file,
                 "name": name,
+                "extract_images": extract_images,
                 "folder_id": folder_id,
             }
         )
@@ -539,6 +551,7 @@ class AsyncUploadResource(AsyncAPIResource):
         *,
         file: FileTypes,
         name: str,
+        extract_images: str | NotGiven = NOT_GIVEN,
         folder_id: str | NotGiven = NOT_GIVEN,
         poll_interval_ms: float | NotGiven = NOT_GIVEN,
         timeout_ms: float | NotGiven = NOT_GIVEN,
@@ -557,11 +570,13 @@ class AsyncUploadResource(AsyncAPIResource):
         Args:
           name: Material name
 
+          extract_images: Whether to extract images from files (true/false, default: true)
+
           folder_id: Folder ID (optional)
 
           poll_interval_ms: Polling interval in milliseconds (default: 2000)
 
-          timeout_ms: Processing timeout in milliseconds (default: 300000)
+          timeout_ms: Processing timeout in milliseconds (default: 300000 - 5 minutes)
 
           extra_headers: Send extra headers
 
@@ -575,6 +590,7 @@ class AsyncUploadResource(AsyncAPIResource):
             {
                 "file": file,
                 "name": name,
+                "extract_images": extract_images,
                 "folder_id": folder_id,
                 "poll_interval_ms": poll_interval_ms,
                 "timeout_ms": timeout_ms,