studyfetch-sdk 0.1.0a3__py3-none-any.whl → 0.1.0a5__py3-none-any.whl

studyfetch_sdk/types/v1/component_create_params.py

@@ -2,13 +2,30 @@
 
 from __future__ import annotations
 
-from typing_extensions import Literal, Required, TypedDict
+from typing import List, Union, Iterable
+from typing_extensions import Literal, Required, Annotated, TypeAlias, TypedDict
 
-__all__ = ["ComponentCreateParams"]
+from ..._utils import PropertyInfo
+
+__all__ = [
+    "ComponentCreateParams",
+    "Config",
+    "ConfigChatConfigDto",
+    "ConfigFlashcardsConfigDto",
+    "ConfigScenariosConfigDto",
+    "ConfigScenariosConfigDtoCharacter",
+    "ConfigScenariosConfigDtoTool",
+    "ConfigPracticeTestConfigDto",
+    "ConfigPracticeTestConfigDtoQuestionDistribution",
+    "ConfigAudioRecapConfigDto",
+    "ConfigExplainersConfigDto",
+    "ConfigUploadsConfigDto",
+    "ConfigTutorMeConfigDto",
+]
 
 
 class ComponentCreateParams(TypedDict, total=False):
-    config: Required[object]
+    config: Required[Config]
     """Component-specific configuration"""
 
     name: Required[str]
@@ -27,3 +44,332 @@ class ComponentCreateParams(TypedDict, total=False):
 
     metadata: object
     """Additional metadata"""
+
+
+class ConfigChatConfigDto(TypedDict, total=False):
+    model: Required[str]
+    """AI model to use"""
+
+    enable_component_creation: Annotated[bool, PropertyInfo(alias="enableComponentCreation")]
+    """Enable component creation"""
+
+    enable_follow_ups: Annotated[bool, PropertyInfo(alias="enableFollowUps")]
+    """Enable follow-up questions"""
+
+    enable_history: Annotated[bool, PropertyInfo(alias="enableHistory")]
+    """Enable conversation history"""
+
+    enable_rag_search: Annotated[bool, PropertyInfo(alias="enableRAGSearch")]
+    """Enable RAG search"""
+
+    enable_voice: Annotated[bool, PropertyInfo(alias="enableVoice")]
+    """Enable voice interactions"""
+
+    enable_web_search: Annotated[bool, PropertyInfo(alias="enableWebSearch")]
+    """Enable web search"""
+
+    folders: List[str]
+    """Folder IDs"""
+
+    materials: List[str]
+    """Material IDs"""
+
+    max_steps: Annotated[float, PropertyInfo(alias="maxSteps")]
+    """Maximum steps for multi-step tool calls"""
+
+    max_tokens: Annotated[float, PropertyInfo(alias="maxTokens")]
+    """Maximum tokens for response"""
+
+    system_prompt: Annotated[str, PropertyInfo(alias="systemPrompt")]
+    """System prompt for the chat"""
+
+    temperature: float
+    """Temperature for response generation"""
+
+
+class ConfigFlashcardsConfigDto(TypedDict, total=False):
+    card_types: Annotated[List[str], PropertyInfo(alias="cardTypes")]
+    """Types of flashcards"""
+
+    difficulty: Literal["easy", "medium", "hard", "mixed"]
+    """Difficulty level"""
+
+    enable_spaced_repetition: Annotated[bool, PropertyInfo(alias="enableSpacedRepetition")]
+    """Enable spaced repetition"""
+
+    folders: List[str]
+    """Folder IDs"""
+
+    learning_steps: Annotated[str, PropertyInfo(alias="learningSteps")]
+    """Learning steps configuration"""
+
+    materials: List[str]
+    """Material IDs"""
+
+    max_review_interval: Annotated[float, PropertyInfo(alias="maxReviewInterval")]
+    """Maximum review interval in days"""
+
+    model: str
+    """AI model to use for flashcard generation"""
+
+    total_flashcards: Annotated[float, PropertyInfo(alias="totalFlashcards")]
+    """Total number of flashcards to generate"""
+
+    view_mode: Annotated[Literal["spaced_repetition", "normal"], PropertyInfo(alias="viewMode")]
+    """View mode for flashcards"""
+
+
+class ConfigScenariosConfigDtoCharacter(TypedDict, total=False):
+    id: Required[str]
+    """Character ID"""
+
+    name: Required[str]
+    """Character name"""
+
+    role: Required[str]
+    """Character role"""
+
+    description: str
+    """Character description"""
+
+
+class ConfigScenariosConfigDtoTool(TypedDict, total=False):
+    id: Required[str]
+    """Tool ID"""
+
+    name: Required[str]
+    """Tool name"""
+
+    data_format: Annotated[str, PropertyInfo(alias="dataFormat")]
+    """Data format provided by the tool"""
+
+    description: str
+    """Tool description"""
+
+    type: str
+    """Tool type"""
+
+
+class ConfigScenariosConfigDto(TypedDict, total=False):
+    characters: Iterable[ConfigScenariosConfigDtoCharacter]
+    """Scenario characters"""
+
+    context: str
+    """Scenario context"""
+
+    enable_history: Annotated[bool, PropertyInfo(alias="enableHistory")]
+    """Enable history"""
+
+    enable_voice: Annotated[bool, PropertyInfo(alias="enableVoice")]
+    """Enable voice"""
+
+    final_answer_prompt: Annotated[str, PropertyInfo(alias="finalAnswerPrompt")]
+    """Final answer prompt"""
+
+    folders: List[str]
+    """Folder IDs"""
+
+    format: str
+    """Scenario format"""
+
+    goal: str
+    """Scenario goal"""
+
+    greeting_character_id: Annotated[str, PropertyInfo(alias="greetingCharacterId")]
+    """Character ID for greeting"""
+
+    greeting_message: Annotated[str, PropertyInfo(alias="greetingMessage")]
+    """Greeting message"""
+
+    materials: List[str]
+    """Material IDs"""
+
+    model: str
+    """AI model to use for scenario generation"""
+
+    placeholder_text: Annotated[str, PropertyInfo(alias="placeholderText")]
+    """Placeholder text"""
+
+    requires_final_answer: Annotated[bool, PropertyInfo(alias="requiresFinalAnswer")]
+    """Requires final answer"""
+
+    tools: Iterable[ConfigScenariosConfigDtoTool]
+    """Available tools"""
+
+
+class ConfigPracticeTestConfigDtoQuestionDistribution(TypedDict, total=False):
+    fillinblank: float
+    """Number of fill in the blank questions"""
+
+    frq: float
+    """Number of free response questions"""
+
+    multiplechoice: float
+    """Number of multiple choice questions"""
+
+    shortanswer: float
+    """Number of short answer questions"""
+
+    truefalse: float
+    """Number of true/false questions"""
+
+
+class ConfigPracticeTestConfigDto(TypedDict, total=False):
+    question_types: Required[Annotated[List[str], PropertyInfo(alias="questionTypes")]]
+    """Question types"""
+
+    ai_generation_mode: Annotated[
+        Literal["balanced", "comprehensive", "focused", "adaptive"], PropertyInfo(alias="aiGenerationMode")
+    ]
+    """AI generation mode"""
+
+    allow_retakes: Annotated[bool, PropertyInfo(alias="allowRetakes")]
+    """Allow retakes"""
+
+    difficulty: Literal["easy", "medium", "hard", "mixed"]
+    """Difficulty level"""
+
+    folders: List[str]
+    """Folder IDs"""
+
+    materials: List[str]
+    """Material IDs"""
+
+    max_attempts: Annotated[float, PropertyInfo(alias="maxAttempts")]
+    """Maximum attempts allowed"""
+
+    model: str
+    """AI model to use for question generation and grading"""
+
+    passing_score: Annotated[float, PropertyInfo(alias="passingScore")]
+    """Passing score percentage"""
+
+    question_distribution: Annotated[
+        ConfigPracticeTestConfigDtoQuestionDistribution, PropertyInfo(alias="questionDistribution")
+    ]
+    """Distribution of question types"""
+
+    questions_per_test: Annotated[float, PropertyInfo(alias="questionsPerTest")]
+    """Number of questions per test"""
+
+    randomize_answers: Annotated[bool, PropertyInfo(alias="randomizeAnswers")]
+    """Randomize answer order"""
+
+    randomize_questions: Annotated[bool, PropertyInfo(alias="randomizeQuestions")]
+    """Randomize question order"""
+
+    show_correct_answers: Annotated[bool, PropertyInfo(alias="showCorrectAnswers")]
+    """Show correct answers after submission"""
+
+    show_explanations: Annotated[bool, PropertyInfo(alias="showExplanations")]
+    """Show explanations for answers"""
+
+    time_limit: Annotated[float, PropertyInfo(alias="timeLimit")]
+    """Time limit in minutes"""
+
+
+class ConfigAudioRecapConfigDto(TypedDict, total=False):
+    duration: float
+    """Duration of audio recap in minutes"""
+
+    folders: List[str]
+    """Folder IDs"""
+
+    is_multi_voice: Annotated[bool, PropertyInfo(alias="isMultiVoice")]
+    """Enable multi-voice conversation mode"""
+
+    materials: List[str]
+    """Material IDs"""
+
+    model: str
+    """AI model to use for generation"""
+
+    num_parts: Annotated[float, PropertyInfo(alias="numParts")]
+    """Number of parts to split the audio into"""
+
+    recap_type: Annotated[Literal["SUMMARY", "LECTURE", "PODCAST", "AUDIO_BOOK"], PropertyInfo(alias="recapType")]
+    """Type of audio recap"""
+
+    theme: str
+    """Theme or style for the audio recap"""
+
+    topic: str
+    """Specific topic to focus on"""
+
+    voice1: str
+    """Primary voice for narration"""
+
+    voice2: str
+    """Secondary voice for multi-voice mode"""
+
+
+class ConfigExplainersConfigDto(TypedDict, total=False):
+    folders: List[str]
+    """Folder IDs"""
+
+    image_search: Annotated[bool, PropertyInfo(alias="imageSearch")]
+    """Enable image search for visuals"""
+
+    materials: List[str]
+    """Material IDs"""
+
+    model: str
+    """AI model to use for generation"""
+
+    style: str
+    """Video style"""
+
+    target_length: Annotated[float, PropertyInfo(alias="targetLength")]
+    """Target length in seconds"""
+
+    title: str
+    """Video title (defaults to component name if not provided)"""
+
+    vertical_video: Annotated[bool, PropertyInfo(alias="verticalVideo")]
+    """Create vertical video format (9:16)"""
+
+    web_search: Annotated[bool, PropertyInfo(alias="webSearch")]
+    """Enable web search for additional content"""
+
+
+class ConfigUploadsConfigDto(TypedDict, total=False):
+    folder_id: Required[Annotated[str, PropertyInfo(alias="folderId")]]
+    """Folder ID where uploads will be stored"""
+
+    folders: List[str]
+    """Folder IDs"""
+
+    materials: List[str]
+    """Material IDs"""
+
+
+class ConfigTutorMeConfigDto(TypedDict, total=False):
+    enable_video: Annotated[bool, PropertyInfo(alias="enableVideo")]
+    """Enable video"""
+
+    enable_voice: Annotated[bool, PropertyInfo(alias="enableVoice")]
+    """Enable voice"""
+
+    folders: List[str]
+    """Folder IDs"""
+
+    materials: List[str]
+    """Material IDs"""
+
+    session_duration: Annotated[float, PropertyInfo(alias="sessionDuration")]
+    """Session duration in minutes"""
+
+    tutor_personality: Annotated[str, PropertyInfo(alias="tutorPersonality")]
+    """Tutor personality"""
+
+
+Config: TypeAlias = Union[
+    ConfigChatConfigDto,
+    ConfigFlashcardsConfigDto,
+    ConfigScenariosConfigDto,
+    ConfigPracticeTestConfigDto,
+    ConfigAudioRecapConfigDto,
+    ConfigExplainersConfigDto,
+    ConfigUploadsConfigDto,
+    ConfigTutorMeConfigDto,
+]

studyfetch_sdk/types/v1/component_create_response.py

@@ -33,7 +33,9 @@ class ComponentCreateResponse(BaseModel):
     status: Literal["active", "inactive", "draft"]
     """Component status"""
 
-    type: Literal["chat", "flashcards", "tests", "scenarios", "explainers", "audio-recap"]
+    type: Literal[
+        "chat", "flashcards", "scenarios", "practice_test", "audio_recap", "tutor_me", "explainers", "uploads"
+    ]
     """Component type"""
 
     updated_at: datetime = FieldInfo(alias="updatedAt")

studyfetch_sdk/types/v1/component_embed_params.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 
+from typing import List
 from typing_extensions import Annotated, TypedDict
 
 from ..._utils import PropertyInfo
@@ -16,8 +17,8 @@ class ComponentEmbedParams(TypedDict, total=False):
     features: Features
     """Feature toggles"""
 
-    group_id: Annotated[str, PropertyInfo(alias="groupId")]
-    """Group ID for collaboration"""
+    group_ids: Annotated[List[str], PropertyInfo(alias="groupIds")]
+    """Group IDs for collaboration"""
 
     height: str
     """Embed height (e.g., "400px", "100vh")"""

studyfetch_sdk/types/v1/component_list_response.py

@@ -33,7 +33,9 @@ class ComponentListResponseItem(BaseModel):
     status: Literal["active", "inactive", "draft"]
     """Component status"""
 
-    type: Literal["chat", "flashcards", "tests", "scenarios", "explainers", "audio-recap"]
+    type: Literal[
+        "chat", "flashcards", "scenarios", "practice_test", "audio_recap", "tutor_me", "explainers", "uploads"
+    ]
     """Component type"""
 
     updated_at: datetime = FieldInfo(alias="updatedAt")

studyfetch_sdk/types/v1/component_retrieve_response.py

@@ -33,7 +33,9 @@ class ComponentRetrieveResponse(BaseModel):
     status: Literal["active", "inactive", "draft"]
     """Component status"""
 
-    type: Literal["chat", "flashcards", "tests", "scenarios", "explainers", "audio-recap"]
+    type: Literal[
+        "chat", "flashcards", "scenarios", "practice_test", "audio_recap", "tutor_me", "explainers", "uploads"
+    ]
     """Component type"""
 
     updated_at: datetime = FieldInfo(alias="updatedAt")

studyfetch_sdk/types/v1/component_update_response.py

@@ -33,7 +33,9 @@ class ComponentUpdateResponse(BaseModel):
     status: Literal["active", "inactive", "draft"]
     """Component status"""
 
-    type: Literal["chat", "flashcards", "tests", "scenarios", "explainers", "audio-recap"]
+    type: Literal[
+        "chat", "flashcards", "scenarios", "practice_test", "audio_recap", "tutor_me", "explainers", "uploads"
+    ]
     """Component type"""
 
     updated_at: datetime = FieldInfo(alias="updatedAt")

studyfetch_sdk/types/v1/explainer_create_params.py

@@ -0,0 +1,45 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List
+from typing_extensions import Required, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["ExplainerCreateParams"]
+
+
+class ExplainerCreateParams(TypedDict, total=False):
+    component_id: Required[Annotated[str, PropertyInfo(alias="componentId")]]
+    """Component ID"""
+
+    folder_ids: Required[Annotated[List[str], PropertyInfo(alias="folderIds")]]
+    """Folder IDs to include"""
+
+    material_ids: Required[Annotated[List[str], PropertyInfo(alias="materialIds")]]
+    """Material IDs to include"""
+
+    target_length: Required[Annotated[float, PropertyInfo(alias="targetLength")]]
+    """Target video length in seconds"""
+
+    title: Required[str]
+    """Title for the explainer video"""
+
+    image_search: Annotated[bool, PropertyInfo(alias="imageSearch")]
+    """Enable image search for visuals"""
+
+    model: str
+    """AI model to use"""
+
+    style: str
+    """Video style"""
+
+    user_id: Annotated[str, PropertyInfo(alias="userId")]
+    """User ID"""
+
+    vertical_video: Annotated[bool, PropertyInfo(alias="verticalVideo")]
+    """Create vertical video format (9:16)"""
+
+    web_search: Annotated[bool, PropertyInfo(alias="webSearch")]
+    """Enable web search for additional content"""

studyfetch_sdk/types/v1/explainer_handle_webhook_params.py

@@ -2,10 +2,52 @@
 
 from __future__ import annotations
 
-from typing_extensions import Required, TypedDict
+from typing import List
+from typing_extensions import Literal, Required, Annotated, TypedDict
 
-__all__ = ["ExplainerHandleWebhookParams"]
+from ..._utils import PropertyInfo
+
+__all__ = ["ExplainerHandleWebhookParams", "Video"]
 
 
 class ExplainerHandleWebhookParams(TypedDict, total=False):
-    body: Required[str]
+    event: Required[Literal["video.completed", "video.progress", "video.failed"]]
+    """Webhook event type"""
+
+    video: Required[Video]
+    """Video data"""
+
+
+class Video(TypedDict, total=False):
+    id: Required[str]
+    """Video ID"""
+
+    image_sources: Annotated[object, PropertyInfo(alias="imageSources")]
+    """Image sources"""
+
+    progress: float
+    """Progress percentage"""
+
+    sections: List[str]
+    """Video sections"""
+
+    stream_id: Annotated[str, PropertyInfo(alias="streamId")]
+    """Stream ID"""
+
+    stream_url: Annotated[str, PropertyInfo(alias="streamUrl")]
+    """Stream URL"""
+
+    thumbnail_url: Annotated[str, PropertyInfo(alias="thumbnailUrl")]
+    """Thumbnail URL"""
+
+    transcript: str
+    """Video transcript"""
+
+    video_url: Annotated[str, PropertyInfo(alias="videoUrl")]
+    """Video URL"""
+
+    web_search_results: Annotated[object, PropertyInfo(alias="webSearchResults")]
+    """Web search results"""
+
+    web_search_sources: Annotated[object, PropertyInfo(alias="webSearchSources")]
+    """Web search sources"""

studyfetch_sdk/types/v1/flashcard_get_all_params.py

@@ -10,8 +10,8 @@ __all__ = ["FlashcardGetAllParams"]
 
 
 class FlashcardGetAllParams(TypedDict, total=False):
-    group_id: Annotated[str, PropertyInfo(alias="groupId")]
-    """Group ID"""
+    group_ids: Annotated[str, PropertyInfo(alias="groupIds")]
+    """Group IDs (comma-separated)"""
 
     limit: float
     """Max number of cards"""

studyfetch_sdk/types/v1/flashcard_get_due_params.py

@@ -10,7 +10,7 @@ __all__ = ["FlashcardGetDueParams"]
 
 
 class FlashcardGetDueParams(TypedDict, total=False):
-    group_id: Required[Annotated[str, PropertyInfo(alias="groupId")]]
+    group_ids: Required[Annotated[str, PropertyInfo(alias="groupIds")]]
 
     limit: float
     """Max number of cards"""

studyfetch_sdk/types/v1/flashcard_get_stats_params.py

@@ -10,8 +10,8 @@ __all__ = ["FlashcardGetStatsParams"]
 
 
 class FlashcardGetStatsParams(TypedDict, total=False):
-    group_id: Annotated[str, PropertyInfo(alias="groupId")]
-    """Group ID"""
+    group_ids: Annotated[str, PropertyInfo(alias="groupIds")]
+    """Group IDs (comma-separated)"""
 
     user_id: Annotated[str, PropertyInfo(alias="userId")]
     """User ID"""

studyfetch_sdk/types/v1/scenario_create_params.py

@@ -2,10 +2,47 @@
 
 from __future__ import annotations
 
-from typing_extensions import Required, TypedDict
+from typing import Iterable
+from typing_extensions import Required, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
 
 __all__ = ["ScenarioCreateParams"]
 
 
 class ScenarioCreateParams(TypedDict, total=False):
-    body: Required[str]
+    component_id: Required[Annotated[str, PropertyInfo(alias="componentId")]]
+    """Associated component ID"""
+
+    name: Required[str]
+    """Scenario name"""
+
+    characters: Iterable[object]
+    """Scenario characters"""
+
+    context: str
+    """Scenario context"""
+
+    description: str
+    """Scenario description"""
+
+    final_answer_prompt: Annotated[str, PropertyInfo(alias="finalAnswerPrompt")]
+    """Prompt for final answer"""
+
+    format: str
+    """Interaction format"""
+
+    goal: str
+    """Scenario goal"""
+
+    greeting_character_id: Annotated[str, PropertyInfo(alias="greetingCharacterId")]
+    """Character ID for greeting"""
+
+    greeting_message: Annotated[str, PropertyInfo(alias="greetingMessage")]
+    """Greeting message"""
+
+    requires_final_answer: Annotated[bool, PropertyInfo(alias="requiresFinalAnswer")]
+    """Whether scenario requires a final answer"""
+
+    tools: Iterable[object]
+    """Available tools"""

studyfetch_sdk/types/v1/scenario_submit_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 Iterable
+from typing_extensions import Required, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["ScenarioSubmitParams"]
+
+
+class ScenarioSubmitParams(TypedDict, total=False):
+    conversation_history: Required[Annotated[Iterable[object], PropertyInfo(alias="conversationHistory")]]
+    """Conversation history"""
+
+    final_answer: Annotated[str, PropertyInfo(alias="finalAnswer")]
+    """Final answer for the scenario"""