studyfetch-sdk 0.1.0a1__py3-none-any.whl

studyfetch_sdk/types/v1/materials/upload_upload_from_url_response.py

@@ -0,0 +1,62 @@
+# 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__ = ["UploadUploadFromURLResponse", "Content"]
+
+
+class Content(BaseModel):
+    filename: Optional[str] = None
+
+    file_size: Optional[float] = FieldInfo(alias="fileSize", default=None)
+
+    mime_type: Optional[str] = FieldInfo(alias="mimeType", default=None)
+
+    s3_key: Optional[str] = FieldInfo(alias="s3Key", default=None)
+
+    s3_url: Optional[str] = FieldInfo(alias="s3Url", default=None)
+
+    text: Optional[str] = None
+
+    url: Optional[str] = None
+
+
+class UploadUploadFromURLResponse(BaseModel):
+    api_id: str = FieldInfo(alias="_id")
+    """Material ID"""
+
+    content: Content
+    """Material content"""
+
+    content_type: Literal["text", "pdf", "video", "audio", "image", "epub"] = FieldInfo(alias="contentType")
+    """Content type"""
+
+    created_at: datetime = FieldInfo(alias="createdAt")
+    """Creation timestamp"""
+
+    folder_id: Optional[str] = FieldInfo(alias="folderId", default=None)
+    """Folder ID"""
+
+    name: str
+    """Material name"""
+
+    organization_id: str = FieldInfo(alias="organizationId")
+    """Organization ID"""
+
+    status: Literal["active", "processing", "pending_upload", "error", "deleted"]
+    """Material status"""
+
+    updated_at: datetime = FieldInfo(alias="updatedAt")
+    """Last update timestamp"""
+
+    metadata: Optional[object] = None
+    """Material metadata"""
+
+    usage: Optional[object] = None
+    """Usage information"""

studyfetch_sdk/types/v1/organizations/__init__.py

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

studyfetch_sdk/types/v1/organizations/logo/__init__.py

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

studyfetch_sdk/types/v1/organizations/profile/__init__.py

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

studyfetch_sdk/types/v1/organizations/team/__init__.py

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

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

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

studyfetch_sdk/types/v1/scenarios/__init__.py

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

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

studyfetch_sdk/types/v1/scenarios/submissions/__init__.py

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

studyfetch_sdk/types/v1/test_create_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__ = ["TestCreateParams"]
+
+
+class TestCreateParams(TypedDict, total=False):
+    component_id: Required[Annotated[str, PropertyInfo(alias="componentId")]]
+    """Component ID"""
+
+    name: str
+    """Test name (optional)"""
+
+    user_id: Annotated[str, PropertyInfo(alias="userId")]
+    """User ID (optional)"""

studyfetch_sdk/types/v1/test_retake_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 Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["TestRetakeParams"]
+
+
+class TestRetakeParams(TypedDict, total=False):
+    user_id: Annotated[str, PropertyInfo(alias="userId")]
+    """User ID (optional)"""

studyfetch_sdk/types/v1/test_submit_answer_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__ = ["TestSubmitAnswerParams"]
+
+
+class TestSubmitAnswerParams(TypedDict, total=False):
+    answer: Required[str]
+    """User answer"""
+
+    question_id: Required[Annotated[str, PropertyInfo(alias="questionId")]]
+    """Question ID"""
+
+    user_id: Annotated[str, PropertyInfo(alias="userId")]
+    """User ID (optional)"""

studyfetch_sdk/types/v1/test_submit_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 Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["TestSubmitParams"]
+
+
+class TestSubmitParams(TypedDict, total=False):
+    user_id: Annotated[str, PropertyInfo(alias="userId")]
+    """User ID (optional)"""

studyfetch_sdk/types/v1/tests/__init__.py

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

studyfetch_sdk/types/v1/upload/__init__.py

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

studyfetch_sdk/types/v1/usage_get_stats_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 Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["UsageGetStatsParams"]
+
+
+class UsageGetStatsParams(TypedDict, total=False):
+    end_date: Annotated[str, PropertyInfo(alias="endDate")]
+    """End date for stats (ISO 8601)"""
+
+    group_id: Annotated[str, PropertyInfo(alias="groupId")]
+    """Filter by group ID"""
+
+    start_date: Annotated[str, PropertyInfo(alias="startDate")]
+    """Start date for stats (ISO 8601)"""
+
+    user_id: Annotated[str, PropertyInfo(alias="userId")]
+    """Filter by user ID"""

studyfetch_sdk/types/v1/usage_get_summary_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 Literal, Required, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["UsageGetSummaryParams"]
+
+
+class UsageGetSummaryParams(TypedDict, total=False):
+    end_date: Required[Annotated[str, PropertyInfo(alias="endDate")]]
+    """End date for summary (ISO 8601)"""
+
+    period: Required[Literal["hourly", "daily", "monthly"]]
+    """Summary period"""
+
+    start_date: Required[Annotated[str, PropertyInfo(alias="startDate")]]
+    """Start date for summary (ISO 8601)"""
+
+    group_by: Annotated[Literal["user", "group", "model", "endpoint"], PropertyInfo(alias="groupBy")]
+    """Group results by"""

studyfetch_sdk/types/v1/usage_list_events_params.py

@@ -0,0 +1,61 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["UsageListEventsParams"]
+
+
+class UsageListEventsParams(TypedDict, total=False):
+    end_date: Annotated[str, PropertyInfo(alias="endDate")]
+    """End date for filtering (ISO 8601)"""
+
+    event_type: Annotated[
+        Literal[
+            "material_created",
+            "material_uploaded",
+            "material_processed",
+            "material_deleted",
+            "component_created",
+            "component_accessed",
+            "component_deleted",
+            "component_usage",
+            "chat_message_sent",
+            "chat_session_started",
+            "chat_session_ended",
+            "test_created",
+            "test_started",
+            "test_completed",
+            "test_question_answered",
+            "test_retaken",
+            "audio_recap_create",
+            "api_call",
+            "cache_hit",
+            "sso_login",
+            "sso_logout",
+            "student_performance",
+        ],
+        PropertyInfo(alias="eventType"),
+    ]
+    """Filter by event type"""
+
+    group_id: Annotated[str, PropertyInfo(alias="groupId")]
+    """Filter by group ID"""
+
+    limit: float
+    """Number of results to return"""
+
+    offset: float
+    """Offset for pagination"""
+
+    resource_id: Annotated[str, PropertyInfo(alias="resourceId")]
+    """Filter by resource ID"""
+
+    start_date: Annotated[str, PropertyInfo(alias="startDate")]
+    """Start date for filtering (ISO 8601)"""
+
+    user_id: Annotated[str, PropertyInfo(alias="userId")]
+    """Filter by user ID"""

studyfetch_sdk/types/v1/usage_track_chat_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_extensions import Literal, Required, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["UsageTrackChatParams"]
+
+
+class UsageTrackChatParams(TypedDict, total=False):
+    input_tokens: Required[Annotated[float, PropertyInfo(alias="inputTokens")]]
+    """Number of input tokens"""
+
+    model: Required[
+        Literal[
+            "openai:gpt-4.1",
+            "openai:gpt-4o",
+            "openai:gpt-4o-mini",
+            "openai:gpt-4",
+            "openai:gpt-3.5-turbo",
+            "openai:o1",
+            "openai:o1-mini",
+            "openai:o3-mini",
+            "anthropic:claude-3-opus",
+            "anthropic:claude-3-sonnet",
+            "anthropic:claude-3-haiku",
+            "google:gemini-pro",
+            "meta:llama-3",
+        ]
+    ]
+    """AI model used"""
+
+    output_tokens: Required[Annotated[float, PropertyInfo(alias="outputTokens")]]
+    """Number of output tokens"""
+
+    session_id: Required[Annotated[str, PropertyInfo(alias="sessionId")]]
+    """Chat session ID"""
+
+    component_id: Annotated[str, PropertyInfo(alias="componentId")]
+    """Component ID"""
+
+    group_id: Annotated[str, PropertyInfo(alias="groupId")]
+    """Group ID"""
+
+    metadata: object
+    """Additional metadata"""
+
+    reasoning_tokens: Annotated[float, PropertyInfo(alias="reasoningTokens")]
+    """Number of reasoning tokens"""
+
+    user_id: Annotated[str, PropertyInfo(alias="userId")]
+    """User ID"""

studyfetch_sdk/types/v1/usage_track_event_params.py

@@ -0,0 +1,128 @@
+# 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__ = ["UsageTrackEventParams"]
+
+
+class UsageTrackEventParams(TypedDict, total=False):
+    event_type: Required[
+        Annotated[
+            Literal[
+                "material_created",
+                "material_uploaded",
+                "material_processed",
+                "material_deleted",
+                "component_created",
+                "component_accessed",
+                "component_deleted",
+                "component_usage",
+                "chat_message_sent",
+                "chat_session_started",
+                "chat_session_ended",
+                "test_created",
+                "test_started",
+                "test_completed",
+                "test_question_answered",
+                "test_retaken",
+                "audio_recap_create",
+                "api_call",
+                "cache_hit",
+                "sso_login",
+                "sso_logout",
+                "student_performance",
+            ],
+            PropertyInfo(alias="eventType"),
+        ]
+    ]
+    """Type of usage event"""
+
+    cache_hit: Annotated[bool, PropertyInfo(alias="cacheHit")]
+    """Whether response was served from cache"""
+
+    component_name: Annotated[str, PropertyInfo(alias="componentName")]
+    """Component name"""
+
+    component_type: Annotated[str, PropertyInfo(alias="componentType")]
+    """Component type"""
+
+    content_size: Annotated[float, PropertyInfo(alias="contentSize")]
+    """Size of content in bytes"""
+
+    endpoint: str
+    """API endpoint accessed"""
+
+    file_size: Annotated[float, PropertyInfo(alias="fileSize")]
+    """File size in bytes"""
+
+    file_type: Annotated[str, PropertyInfo(alias="fileType")]
+    """File MIME type"""
+
+    group_id: Annotated[str, PropertyInfo(alias="groupId")]
+    """Group ID for collaborative sessions"""
+
+    input_tokens: Annotated[float, PropertyInfo(alias="inputTokens")]
+    """Number of input tokens"""
+
+    ip_address: Annotated[str, PropertyInfo(alias="ipAddress")]
+    """Client IP address"""
+
+    metadata: object
+    """Additional metadata"""
+
+    method: str
+    """HTTP method used"""
+
+    model: Literal[
+        "openai:gpt-4.1",
+        "openai:gpt-4o",
+        "openai:gpt-4o-mini",
+        "openai:gpt-4",
+        "openai:gpt-3.5-turbo",
+        "openai:o1",
+        "openai:o1-mini",
+        "openai:o3-mini",
+        "anthropic:claude-3-opus",
+        "anthropic:claude-3-sonnet",
+        "anthropic:claude-3-haiku",
+        "google:gemini-pro",
+        "meta:llama-3",
+    ]
+    """AI model used"""
+
+    output_tokens: Annotated[float, PropertyInfo(alias="outputTokens")]
+    """Number of output tokens"""
+
+    performance_data: Annotated[object, PropertyInfo(alias="performanceData")]
+    """Performance metrics data"""
+
+    reasoning_tokens: Annotated[float, PropertyInfo(alias="reasoningTokens")]
+    """Number of reasoning tokens"""
+
+    resource_id: Annotated[str, PropertyInfo(alias="resourceId")]
+    """Resource ID being accessed"""
+
+    resource_type: Annotated[str, PropertyInfo(alias="resourceType")]
+    """Type of resource"""
+
+    response_time: Annotated[float, PropertyInfo(alias="responseTime")]
+    """Response time in milliseconds"""
+
+    session_id: Annotated[str, PropertyInfo(alias="sessionId")]
+    """Session ID"""
+
+    status_code: Annotated[float, PropertyInfo(alias="statusCode")]
+    """HTTP status code"""
+
+    total_tokens: Annotated[float, PropertyInfo(alias="totalTokens")]
+    """Total number of tokens"""
+
+    user_agent: Annotated[str, PropertyInfo(alias="userAgent")]
+    """Client user agent"""
+
+    user_id: Annotated[str, PropertyInfo(alias="userId")]
+    """User ID"""