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

studyfetch_sdk/types/v1/component_list_params.py

@@ -9,6 +9,14 @@ __all__ = ["ComponentListParams"]
 
 class ComponentListParams(TypedDict, total=False):
     type: Literal[
-        "chat", "flashcards", "scenarios", "practice_test", "audio_recap", "tutor_me", "explainers", "uploads"
+        "chat",
+        "data_analyst",
+        "flashcards",
+        "scenarios",
+        "practice_test",
+        "audio_recap",
+        "tutor_me",
+        "explainers",
+        "uploads",
     ]
     """Filter by component type"""

studyfetch_sdk/types/v1/content_param.py

@@ -0,0 +1,23 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, Required, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["ContentParam"]
+
+
+class ContentParam(TypedDict, total=False):
+    type: Required[Literal["text", "pdf", "video", "audio", "url"]]
+    """Type of content"""
+
+    source_url: Annotated[str, PropertyInfo(alias="sourceUrl")]
+    """URL to fetch content from"""
+
+    text: str
+    """Text content (for text type)"""
+
+    url: str
+    """URL to the content (for url type)"""

studyfetch_sdk/types/v1/data_analyst/__init__.py

@@ -0,0 +1,5 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from .session_retrieve_params import SessionRetrieveParams as SessionRetrieveParams

studyfetch_sdk/types/v1/data_analyst/session_retrieve_params.py

@@ -0,0 +1,11 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["SessionRetrieveParams"]
+
+
+class SessionRetrieveParams(TypedDict, total=False):
+    limit: Required[str]

studyfetch_sdk/types/v1/data_analyst_retrieve_session_params.py

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["DataAnalystRetrieveSessionParams"]
+
+
+class DataAnalystRetrieveSessionParams(TypedDict, total=False):
+    user_id: Required[Annotated[str, PropertyInfo(alias="userId")]]

studyfetch_sdk/types/v1/data_analyst_send_message_params.py

@@ -0,0 +1,54 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List, Iterable
+from typing_extensions import Required, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["DataAnalystSendMessageParams", "Message", "MessageImage"]
+
+
+class DataAnalystSendMessageParams(TypedDict, total=False):
+    component_id: Required[Annotated[str, PropertyInfo(alias="componentId")]]
+    """Component ID for context"""
+
+    message: Required[Message]
+    """Chat message content"""
+
+    x_component_id: Required[Annotated[str, PropertyInfo(alias="x-component-id")]]
+
+    context: object
+    """Additional context data"""
+
+    group_ids: Annotated[List[str], PropertyInfo(alias="groupIds")]
+    """Group IDs for collaboration"""
+
+    session_id: Annotated[str, PropertyInfo(alias="sessionId")]
+    """Session ID for conversation continuity"""
+
+    user_id: Annotated[str, PropertyInfo(alias="userId")]
+    """User ID for tracking"""
+
+
+class MessageImage(TypedDict, total=False):
+    base64: str
+    """Base64 encoded image data"""
+
+    caption: str
+    """Caption for the image"""
+
+    mime_type: Annotated[str, PropertyInfo(alias="mimeType")]
+    """MIME type of the image"""
+
+    url: str
+    """URL of the image"""
+
+
+class Message(TypedDict, total=False):
+    images: Iterable[MessageImage]
+    """Images attached to the message"""
+
+    text: str
+    """Text content of the message"""

studyfetch_sdk/types/v1/data_analyst_stream_params.py

@@ -0,0 +1,28 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Iterable
+from typing_extensions import Literal, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["DataAnalystStreamParams", "Message"]
+
+
+class DataAnalystStreamParams(TypedDict, total=False):
+    context: object
+
+    group_id: Annotated[str, PropertyInfo(alias="groupId")]
+
+    messages: Iterable[Message]
+
+    user_id: Annotated[str, PropertyInfo(alias="userId")]
+
+    x_component_id: Annotated[str, PropertyInfo(alias="x-component-id")]
+
+
+class Message(TypedDict, total=False):
+    content: str
+
+    role: Literal["user", "assistant", "system"]

studyfetch_sdk/types/v1/material_batch_create_params.py

@@ -0,0 +1,29 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Iterable
+from typing_extensions import Required, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["MaterialBatchCreateParams", "Material"]
+
+
+class MaterialBatchCreateParams(TypedDict, total=False):
+    materials: Required[Iterable[Material]]
+    """Array of materials to create"""
+
+
+class Material(TypedDict, total=False):
+    content_type: Required[Annotated[str, PropertyInfo(alias="contentType")]]
+    """MIME type"""
+
+    filename: Required[str]
+    """Filename"""
+
+    name: Required[str]
+    """Material name"""
+
+    folder_id: Annotated[str, PropertyInfo(alias="folderId")]
+    """Folder ID"""

studyfetch_sdk/types/v1/material_batch_create_response.py

@@ -0,0 +1,27 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+from typing_extensions import TypeAlias
+
+from pydantic import Field as FieldInfo
+
+from ..._models import BaseModel
+
+__all__ = ["MaterialBatchCreateResponse", "MaterialBatchCreateResponseItem"]
+
+
+class MaterialBatchCreateResponseItem(BaseModel):
+    material_id: str = FieldInfo(alias="materialId")
+    """Material ID"""
+
+    name: str
+    """Material name"""
+
+    s3_key: str = FieldInfo(alias="s3Key")
+    """S3 key"""
+
+    upload_url: str = FieldInfo(alias="uploadUrl")
+    """Presigned upload URL"""
+
+
+MaterialBatchCreateResponse: TypeAlias = List[MaterialBatchCreateResponseItem]

studyfetch_sdk/types/v1/material_create_and_process_params.py

@@ -0,0 +1,27 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+from .content_param import ContentParam
+
+__all__ = ["MaterialCreateAndProcessParams"]
+
+
+class MaterialCreateAndProcessParams(TypedDict, total=False):
+    content: Required[ContentParam]
+    """Content details"""
+
+    name: Required[str]
+    """Name of the material"""
+
+    folder_id: Annotated[str, PropertyInfo(alias="folderId")]
+    """Folder ID to place the material in"""
+
+    poll_interval_ms: Annotated[float, PropertyInfo(alias="pollIntervalMs")]
+    """Polling interval in milliseconds (default: 2 seconds)"""
+
+    timeout_ms: Annotated[float, PropertyInfo(alias="timeoutMs")]
+    """Maximum time to wait for processing in milliseconds (default: 5 minutes)"""

studyfetch_sdk/types/v1/material_create_params.py

@@ -2,15 +2,16 @@
 
 from __future__ import annotations
 
-from typing_extensions import Literal, Required, Annotated, TypedDict
+from typing_extensions import Required, Annotated, TypedDict
 
 from ..._utils import PropertyInfo
+from .content_param import ContentParam
 
-__all__ = ["MaterialCreateParams", "Content"]
+__all__ = ["MaterialCreateParams"]
 
 
 class MaterialCreateParams(TypedDict, total=False):
-    content: Required[Content]
+    content: Required[ContentParam]
     """Content details"""
 
     name: Required[str]
@@ -18,17 +19,3 @@ class MaterialCreateParams(TypedDict, total=False):
 
     folder_id: Annotated[str, PropertyInfo(alias="folderId")]
     """Folder ID to place the material in"""
-
-
-class Content(TypedDict, total=False):
-    type: Required[Literal["text", "pdf", "video", "audio", "url"]]
-    """Type of content"""
-
-    source_url: Annotated[str, PropertyInfo(alias="sourceUrl")]
-    """URL to fetch content from"""
-
-    text: str
-    """Text content (for text type)"""
-
-    url: str
-    """URL to the content (for url type)"""

studyfetch_sdk/types/v1/material_debug_response.py

@@ -0,0 +1,47 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from pydantic import Field as FieldInfo
+
+from ..._models import BaseModel
+
+__all__ = ["MaterialDebugResponse", "Image"]
+
+
+class Image(BaseModel):
+    id: Optional[str] = None
+
+    description: Optional[str] = None
+
+    page_index: Optional[float] = FieldInfo(alias="pageIndex", default=None)
+
+    s3_key: Optional[str] = FieldInfo(alias="s3Key", default=None)
+
+    s3_url: Optional[str] = FieldInfo(alias="s3Url", default=None)
+
+
+class MaterialDebugResponse(BaseModel):
+    content: object
+    """Content details"""
+
+    content_type: str = FieldInfo(alias="contentType")
+    """Content type"""
+
+    images: List[Image]
+    """Processed images"""
+
+    material_id: str = FieldInfo(alias="materialId")
+    """Material ID"""
+
+    metadata: object
+    """Material metadata"""
+
+    name: str
+    """Material name"""
+
+    status: str
+    """Processing status"""
+
+    transcript_structure: Optional[object] = FieldInfo(alias="transcriptStructure", default=None)
+    """Transcript structure for videos"""

studyfetch_sdk/types/v1/material_get_download_url_params.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing_extensions import Required, Annotated, TypedDict
+from typing_extensions import Annotated, TypedDict
 
 from ..._utils import PropertyInfo
 
@@ -10,4 +10,5 @@ __all__ = ["MaterialGetDownloadURLParams"]
 
 
 class MaterialGetDownloadURLParams(TypedDict, total=False):
-    expires_in: Required[Annotated[str, PropertyInfo(alias="expiresIn")]]
+    expires_in: Annotated[float, PropertyInfo(alias="expiresIn")]
+    """URL expiration time in seconds (default: 3600)"""

studyfetch_sdk/types/v1/material_get_download_url_response.py

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from pydantic import Field as FieldInfo
+
+from ..._models import BaseModel
+
+__all__ = ["MaterialGetDownloadURLResponse"]
+
+
+class MaterialGetDownloadURLResponse(BaseModel):
+    download_url: str = FieldInfo(alias="downloadUrl")
+    """Temporary download URL"""

studyfetch_sdk/types/v1/material_move_params.py

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Optional
+from typing_extensions import Required, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["MaterialMoveParams"]
+
+
+class MaterialMoveParams(TypedDict, total=False):
+    folder_id: Required[Annotated[Optional[str], PropertyInfo(alias="folderId")]]
+    """Target folder ID (null for root)"""

studyfetch_sdk/types/v1/material_rename_params.py

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["MaterialRenameParams"]
+
+
+class MaterialRenameParams(TypedDict, total=False):
+    name: Required[str]
+    """New name for the material"""

studyfetch_sdk/types/v1/material_search_params.py

@@ -15,13 +15,10 @@ class MaterialSearchParams(TypedDict, total=False):
     """Search query"""
 
     folder_ids: Annotated[List[str], PropertyInfo(alias="folderIds")]
-    """
-    Optional: Limit search to materials within specific folders (includes
-    subfolders)
-    """
+    """Limit search to materials within specific folders (includes subfolders)"""
 
     material_ids: Annotated[List[str], PropertyInfo(alias="materialIds")]
-    """Optional: Limit search to specific material IDs"""
+    """Limit search to specific material IDs"""
 
     top_k: Annotated[float, PropertyInfo(alias="topK")]
-    """Number of results to return (default: 5)"""
+    """Number of results to return"""

studyfetch_sdk/types/v1/material_search_response.py

@@ -0,0 +1,54 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from pydantic import Field as FieldInfo
+
+from ..._models import BaseModel
+
+__all__ = ["MaterialSearchResponse", "Result", "ResultMaterial", "Scope"]
+
+
+class ResultMaterial(BaseModel):
+    id: Optional[str] = None
+
+    content_type: Optional[str] = FieldInfo(alias="contentType", default=None)
+
+    name: Optional[str] = None
+
+
+class Result(BaseModel):
+    chunk_index: float = FieldInfo(alias="chunkIndex")
+    """Chunk index within the material"""
+
+    material: Optional[ResultMaterial] = None
+    """Material information"""
+
+    score: float
+    """Relevance score (0-1)"""
+
+    text: str
+    """Matched text chunk"""
+
+
+class Scope(BaseModel):
+    folder_ids: Optional[List[str]] = FieldInfo(alias="folderIds", default=None)
+
+    material_ids: Optional[List[str]] = FieldInfo(alias="materialIds", default=None)
+
+
+class MaterialSearchResponse(BaseModel):
+    filtered: bool
+    """Whether results were filtered by scope"""
+
+    query: str
+    """Original search query"""
+
+    results: List[Result]
+    """Search results"""
+
+    scope: Scope
+    """Search scope"""
+
+    total_results: float = FieldInfo(alias="totalResults")
+    """Total number of results"""

studyfetch_sdk/types/v1/materials/__init__.py

@@ -2,5 +2,16 @@
 
 from __future__ import annotations
 
+from .bulk_move_params import BulkMoveParams as BulkMoveParams
+from .bulk_move_response import BulkMoveResponse as BulkMoveResponse
+from .test_perform_ocr_response import TestPerformOcrResponse as TestPerformOcrResponse
 from .upload_upload_file_params import UploadUploadFileParams as UploadUploadFileParams
+from .test_process_epub_response import TestProcessEpubResponse as TestProcessEpubResponse
+from .test_process_image_response import TestProcessImageResponse as TestProcessImageResponse
+from .test_process_video_response import TestProcessVideoResponse as TestProcessVideoResponse
+from .upload_complete_upload_params import UploadCompleteUploadParams as UploadCompleteUploadParams
 from .upload_upload_from_url_params import UploadUploadFromURLParams as UploadUploadFromURLParams
+from .upload_create_presigned_url_params import UploadCreatePresignedURLParams as UploadCreatePresignedURLParams
+from .upload_create_presigned_url_response import UploadCreatePresignedURLResponse as UploadCreatePresignedURLResponse
+from .upload_upload_url_and_process_params import UploadUploadURLAndProcessParams as UploadUploadURLAndProcessParams
+from .upload_upload_file_and_process_params import UploadUploadFileAndProcessParams as UploadUploadFileAndProcessParams

studyfetch_sdk/types/v1/materials/bulk_move_params.py

@@ -0,0 +1,18 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List, Optional
+from typing_extensions import Required, Annotated, TypedDict
+
+from ...._utils import PropertyInfo
+
+__all__ = ["BulkMoveParams"]
+
+
+class BulkMoveParams(TypedDict, total=False):
+    folder_id: Required[Annotated[Optional[str], PropertyInfo(alias="folderId")]]
+    """Target folder ID (null for root)"""
+
+    material_ids: Required[Annotated[List[str], PropertyInfo(alias="materialIds")]]
+    """Array of material IDs to move"""

studyfetch_sdk/types/v1/materials/bulk_move_response.py

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from pydantic import Field as FieldInfo
+
+from ...._models import BaseModel
+
+__all__ = ["BulkMoveResponse"]
+
+
+class BulkMoveResponse(BaseModel):
+    moved_count: float = FieldInfo(alias="movedCount")
+    """Number of materials moved"""
+
+    success: bool
+    """Operation success status"""

studyfetch_sdk/types/v1/materials/test_perform_ocr_response.py

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from pydantic import Field as FieldInfo
+
+from ...._models import BaseModel
+
+__all__ = ["TestPerformOcrResponse"]
+
+
+class TestPerformOcrResponse(BaseModel):
+    __test__ = False
+    first_chars: str = FieldInfo(alias="firstChars")
+    """First 500 characters of extracted text"""
+
+    success: bool
+    """Test success status"""
+
+    text_length: float = FieldInfo(alias="textLength")
+    """Length of extracted text"""

studyfetch_sdk/types/v1/materials/test_process_epub_response.py

@@ -0,0 +1,30 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from pydantic import Field as FieldInfo
+
+from ...._models import BaseModel
+
+__all__ = ["TestProcessEpubResponse"]
+
+
+class TestProcessEpubResponse(BaseModel):
+    __test__ = False
+    success: bool
+    """Test success status"""
+
+    epub_size: Optional[float] = FieldInfo(alias="epubSize", default=None)
+    """EPUB file size in bytes"""
+
+    epub_size_mb: Optional[str] = FieldInfo(alias="epubSizeMB", default=None)
+    """EPUB file size in MB"""
+
+    error: Optional[str] = None
+    """Error message if failed"""
+
+    message: Optional[str] = None
+    """Success message"""
+
+    stack: Optional[str] = None
+    """Error stack trace"""

studyfetch_sdk/types/v1/materials/test_process_image_response.py

@@ -0,0 +1,30 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from pydantic import Field as FieldInfo
+
+from ...._models import BaseModel
+
+__all__ = ["TestProcessImageResponse"]
+
+
+class TestProcessImageResponse(BaseModel):
+    __test__ = False
+    success: bool
+    """Test success status"""
+
+    error: Optional[str] = None
+    """Error message if failed"""
+
+    image_info: Optional[object] = FieldInfo(alias="imageInfo", default=None)
+    """Image info if no base64 data"""
+
+    message: Optional[str] = None
+    """Success message"""
+
+    results: Optional[object] = None
+    """Test results"""
+
+    stack: Optional[str] = None
+    """Error stack trace"""

studyfetch_sdk/types/v1/materials/test_process_video_response.py

@@ -0,0 +1,25 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from ...._models import BaseModel
+
+__all__ = ["TestProcessVideoResponse"]
+
+
+class TestProcessVideoResponse(BaseModel):
+    __test__ = False
+    success: bool
+    """Test success status"""
+
+    error: Optional[str] = None
+    """Error message if failed"""
+
+    message: Optional[str] = None
+    """Success message"""
+
+    stack: Optional[str] = None
+    """Error stack trace"""
+
+    tests: Optional[object] = None
+    """Test results"""

studyfetch_sdk/types/v1/materials/upload_complete_upload_params.py

@@ -0,0 +1,20 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, Annotated, TypedDict
+
+from ...._utils import PropertyInfo
+
+__all__ = ["UploadCompleteUploadParams"]
+
+
+class UploadCompleteUploadParams(TypedDict, total=False):
+    material_id: Required[Annotated[str, PropertyInfo(alias="materialId")]]
+    """The ID of the material that was uploaded"""
+
+    organization_id: Required[Annotated[str, PropertyInfo(alias="organizationId")]]
+    """The ID of the organization"""
+
+    s3_key: Required[Annotated[str, PropertyInfo(alias="s3Key")]]
+    """The S3 key of the uploaded file"""