studyfetch-sdk 0.1.0a1__py3-none-any.whl

studyfetch_sdk/types/v1/auth/number_2fa_regenerate_backup_codes_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__ = ["Number2faRegenerateBackupCodesParams"]
+
+
+class Number2faRegenerateBackupCodesParams(TypedDict, total=False):
+    password: Required[str]
+    """User password for verification"""

studyfetch_sdk/types/v1/auth/number_2fa_send_code_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__ = ["Number2faSendCodeParams"]
+
+
+class Number2faSendCodeParams(TypedDict, total=False):
+    email: Required[str]
+    """Email to send verification code"""

studyfetch_sdk/types/v1/auth_register_new_user_params.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 Required, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["AuthRegisterNewUserParams"]
+
+
+class AuthRegisterNewUserParams(TypedDict, total=False):
+    email: Required[str]
+    """User email address"""
+
+    name: Required[str]
+    """User full name"""
+
+    organization_name: Required[Annotated[str, PropertyInfo(alias="organizationName")]]
+    """Organization name"""
+
+    password: Required[str]
+    """User password"""

studyfetch_sdk/types/v1/auth_request_password_reset_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__ = ["AuthRequestPasswordResetParams"]
+
+
+class AuthRequestPasswordResetParams(TypedDict, total=False):
+    email: Required[str]
+    """Email address to send reset link"""

studyfetch_sdk/types/v1/auth_reset_password_params.py

@@ -0,0 +1,17 @@
+# 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__ = ["AuthResetPasswordParams"]
+
+
+class AuthResetPasswordParams(TypedDict, total=False):
+    token: Required[str]
+    """Password reset token from email"""
+
+    new_password: Required[Annotated[str, PropertyInfo(alias="newPassword")]]
+    """New password"""

studyfetch_sdk/types/v1/chat/__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/chat/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/chat_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__ = ["ChatRetrieveSessionParams"]
+
+
+class ChatRetrieveSessionParams(TypedDict, total=False):
+    user_id: Required[Annotated[str, PropertyInfo(alias="userId")]]

studyfetch_sdk/types/v1/chat_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 Iterable
+from typing_extensions import Required, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["ChatSendMessageParams", "Message", "MessageImage"]
+
+
+class ChatSendMessageParams(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_id: Annotated[str, PropertyInfo(alias="groupId")]
+    """Group ID 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/chat_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__ = ["ChatStreamParams", "Message"]
+
+
+class ChatStreamParams(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/component_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_extensions import Literal, Required, TypedDict
+
+__all__ = ["ComponentCreateParams"]
+
+
+class ComponentCreateParams(TypedDict, total=False):
+    config: Required[object]
+    """Component-specific configuration"""
+
+    name: Required[str]
+    """Name of the component"""
+
+    origin: Required[Literal["chat", "classroom", "upload", "console", "api"]]
+    """Origin of the component"""
+
+    type: Required[
+        Literal["chat", "flashcards", "scenarios", "practice_test", "audio_recap", "tutor_me", "explainers", "uploads"]
+    ]
+    """Type of component to create"""
+
+    description: str
+    """Component description"""
+
+    metadata: object
+    """Additional metadata"""

studyfetch_sdk/types/v1/component_create_response.py

@@ -0,0 +1,46 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from pydantic import Field as FieldInfo
+
+from ..._models import BaseModel
+
+__all__ = ["ComponentCreateResponse"]
+
+
+class ComponentCreateResponse(BaseModel):
+    api_id: str = FieldInfo(alias="_id")
+    """Component ID (MongoDB ObjectId)"""
+
+    component_id: str = FieldInfo(alias="componentId")
+    """Unique component identifier"""
+
+    config: object
+    """Component configuration"""
+
+    created_at: datetime = FieldInfo(alias="createdAt")
+    """Creation timestamp"""
+
+    name: str
+    """Component name"""
+
+    organization: str
+    """Organization ID"""
+
+    status: Literal["active", "inactive", "draft"]
+    """Component status"""
+
+    type: Literal["chat", "flashcards", "tests", "scenarios", "explainers", "audio-recap"]
+    """Component type"""
+
+    updated_at: datetime = FieldInfo(alias="updatedAt")
+    """Last update timestamp"""
+
+    usage: object
+    """Usage statistics"""
+
+    description: Optional[str] = None
+    """Component description"""

studyfetch_sdk/types/v1/component_embed_params.py

@@ -0,0 +1,99 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["ComponentEmbedParams", "Features", "Theme"]
+
+
+class ComponentEmbedParams(TypedDict, total=False):
+    expiry_hours: Annotated[float, PropertyInfo(alias="expiryHours")]
+    """Token expiry time in hours"""
+
+    features: Features
+    """Feature toggles"""
+
+    group_id: Annotated[str, PropertyInfo(alias="groupId")]
+    """Group ID for collaboration"""
+
+    height: str
+    """Embed height (e.g., "400px", "100vh")"""
+
+    session_id: Annotated[str, PropertyInfo(alias="sessionId")]
+    """Session ID for continuity"""
+
+    theme: Theme
+    """Theme customization"""
+
+    user_id: Annotated[str, PropertyInfo(alias="userId")]
+    """User ID for tracking"""
+
+    width: str
+    """Embed width (e.g., "100%", "600px")"""
+
+
+class Features(TypedDict, total=False):
+    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 history"""
+
+    enable_image_sources: Annotated[bool, PropertyInfo(alias="enableImageSources")]
+    """Enable image sources"""
+
+    enable_outline: Annotated[bool, PropertyInfo(alias="enableOutline")]
+    """Enable outline"""
+
+    enable_transcript: Annotated[bool, PropertyInfo(alias="enableTranscript")]
+    """Enable transcript"""
+
+    enable_voice: Annotated[bool, PropertyInfo(alias="enableVoice")]
+    """Enable voice input"""
+
+    enable_web_search: Annotated[bool, PropertyInfo(alias="enableWebSearch")]
+    """Enable web search"""
+
+    enable_web_search_sources: Annotated[bool, PropertyInfo(alias="enableWebSearchSources")]
+    """Enable web search sources"""
+
+    placeholder_text: Annotated[str, PropertyInfo(alias="placeholderText")]
+    """Placeholder text"""
+
+
+class Theme(TypedDict, total=False):
+    background_color: Annotated[str, PropertyInfo(alias="backgroundColor")]
+    """Background color (hex)"""
+
+    border_radius: Annotated[str, PropertyInfo(alias="borderRadius")]
+    """Border radius"""
+
+    font_family: Annotated[str, PropertyInfo(alias="fontFamily")]
+    """Font family"""
+
+    font_size: Annotated[str, PropertyInfo(alias="fontSize")]
+    """Font size"""
+
+    hide_branding: Annotated[bool, PropertyInfo(alias="hideBranding")]
+    """Hide branding"""
+
+    logo_url: Annotated[str, PropertyInfo(alias="logoUrl")]
+    """Logo URL"""
+
+    padding: str
+    """Padding"""
+
+    primary_color: Annotated[str, PropertyInfo(alias="primaryColor")]
+    """Primary color (hex)"""
+
+    secondary_color: Annotated[str, PropertyInfo(alias="secondaryColor")]
+    """Secondary color (hex)"""
+
+    text_color: Annotated[str, PropertyInfo(alias="textColor")]
+    """Text color (hex)"""

studyfetch_sdk/types/v1/component_embed_response.py

@@ -0,0 +1,38 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import datetime
+
+from pydantic import Field as FieldInfo
+
+from ..._models import BaseModel
+
+__all__ = ["ComponentEmbedResponse", "Options"]
+
+
+class Options(BaseModel):
+    height: Optional[str] = None
+    """Embed height"""
+
+    width: Optional[str] = None
+    """Embed width"""
+
+
+class ComponentEmbedResponse(BaseModel):
+    token: str
+    """JWT token for authentication"""
+
+    component_id: str = FieldInfo(alias="componentId")
+    """Component ID"""
+
+    component_type: str = FieldInfo(alias="componentType")
+    """Component type"""
+
+    embed_url: str = FieldInfo(alias="embedUrl")
+    """The embed URL for iframe integration"""
+
+    expires_at: datetime = FieldInfo(alias="expiresAt")
+    """Token expiration timestamp"""
+
+    options: Options
+    """Embed options"""

studyfetch_sdk/types/v1/component_list_params.py

@@ -0,0 +1,14 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, TypedDict
+
+__all__ = ["ComponentListParams"]
+
+
+class ComponentListParams(TypedDict, total=False):
+    type: Literal[
+        "chat", "flashcards", "scenarios", "practice_test", "audio_recap", "tutor_me", "explainers", "uploads"
+    ]
+    """Filter by component type"""

studyfetch_sdk/types/v1/component_list_response.py

@@ -0,0 +1,49 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from datetime import datetime
+from typing_extensions import Literal, TypeAlias
+
+from pydantic import Field as FieldInfo
+
+from ..._models import BaseModel
+
+__all__ = ["ComponentListResponse", "ComponentListResponseItem"]
+
+
+class ComponentListResponseItem(BaseModel):
+    api_id: str = FieldInfo(alias="_id")
+    """Component ID (MongoDB ObjectId)"""
+
+    component_id: str = FieldInfo(alias="componentId")
+    """Unique component identifier"""
+
+    config: object
+    """Component configuration"""
+
+    created_at: datetime = FieldInfo(alias="createdAt")
+    """Creation timestamp"""
+
+    name: str
+    """Component name"""
+
+    organization: str
+    """Organization ID"""
+
+    status: Literal["active", "inactive", "draft"]
+    """Component status"""
+
+    type: Literal["chat", "flashcards", "tests", "scenarios", "explainers", "audio-recap"]
+    """Component type"""
+
+    updated_at: datetime = FieldInfo(alias="updatedAt")
+    """Last update timestamp"""
+
+    usage: object
+    """Usage statistics"""
+
+    description: Optional[str] = None
+    """Component description"""
+
+
+ComponentListResponse: TypeAlias = List[ComponentListResponseItem]

studyfetch_sdk/types/v1/component_retrieve_response.py

@@ -0,0 +1,46 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from pydantic import Field as FieldInfo
+
+from ..._models import BaseModel
+
+__all__ = ["ComponentRetrieveResponse"]
+
+
+class ComponentRetrieveResponse(BaseModel):
+    api_id: str = FieldInfo(alias="_id")
+    """Component ID (MongoDB ObjectId)"""
+
+    component_id: str = FieldInfo(alias="componentId")
+    """Unique component identifier"""
+
+    config: object
+    """Component configuration"""
+
+    created_at: datetime = FieldInfo(alias="createdAt")
+    """Creation timestamp"""
+
+    name: str
+    """Component name"""
+
+    organization: str
+    """Organization ID"""
+
+    status: Literal["active", "inactive", "draft"]
+    """Component status"""
+
+    type: Literal["chat", "flashcards", "tests", "scenarios", "explainers", "audio-recap"]
+    """Component type"""
+
+    updated_at: datetime = FieldInfo(alias="updatedAt")
+    """Last update timestamp"""
+
+    usage: object
+    """Usage statistics"""
+
+    description: Optional[str] = None
+    """Component description"""

studyfetch_sdk/types/v1/component_update_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 Literal, TypedDict
+
+__all__ = ["ComponentUpdateParams"]
+
+
+class ComponentUpdateParams(TypedDict, total=False):
+    status: Literal["draft", "active", "inactive", "processing", "error"]
+    """Component status"""

studyfetch_sdk/types/v1/component_update_response.py

@@ -0,0 +1,46 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from pydantic import Field as FieldInfo
+
+from ..._models import BaseModel
+
+__all__ = ["ComponentUpdateResponse"]
+
+
+class ComponentUpdateResponse(BaseModel):
+    api_id: str = FieldInfo(alias="_id")
+    """Component ID (MongoDB ObjectId)"""
+
+    component_id: str = FieldInfo(alias="componentId")
+    """Unique component identifier"""
+
+    config: object
+    """Component configuration"""
+
+    created_at: datetime = FieldInfo(alias="createdAt")
+    """Creation timestamp"""
+
+    name: str
+    """Component name"""
+
+    organization: str
+    """Organization ID"""
+
+    status: Literal["active", "inactive", "draft"]
+    """Component status"""
+
+    type: Literal["chat", "flashcards", "tests", "scenarios", "explainers", "audio-recap"]
+    """Component type"""
+
+    updated_at: datetime = FieldInfo(alias="updatedAt")
+    """Last update timestamp"""
+
+    usage: object
+    """Usage statistics"""
+
+    description: Optional[str] = None
+    """Component description"""

studyfetch_sdk/types/v1/embed/__init__.py

@@ -0,0 +1,6 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from .component_interact_params import ComponentInteractParams as ComponentInteractParams
+from .component_retrieve_params import ComponentRetrieveParams as ComponentRetrieveParams

studyfetch_sdk/types/v1/embed/component_interact_params.py

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

studyfetch_sdk/types/v1/embed/component_retrieve_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__ = ["ComponentRetrieveParams"]
+
+
+class ComponentRetrieveParams(TypedDict, total=False):
+    token: Required[str]
+    """Embed token"""

studyfetch_sdk/types/v1/embed_get_theme_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__ = ["EmbedGetThemeParams"]
+
+
+class EmbedGetThemeParams(TypedDict, total=False):
+    token: Required[str]
+    """Embed token"""

studyfetch_sdk/types/v1/embed_verify_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__ = ["EmbedVerifyParams"]
+
+
+class EmbedVerifyParams(TypedDict, total=False):
+    token: Required[str]
+    """Embed token to verify"""

studyfetch_sdk/types/v1/explainer_handle_webhook_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__ = ["ExplainerHandleWebhookParams"]
+
+
+class ExplainerHandleWebhookParams(TypedDict, total=False):
+    body: Required[str]