studyfetch-sdk 0.1.0a1__py3-none-any.whl

studyfetch_sdk/types/v1/flashcard_batch_process_params.py

@@ -0,0 +1,36 @@
+# 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, Required, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["FlashcardBatchProcessParams", "Operation"]
+
+
+class FlashcardBatchProcessParams(TypedDict, total=False):
+    operations: Required[Iterable[Operation]]
+
+    group_id: Annotated[str, PropertyInfo(alias="groupId")]
+    """Group ID (optional)"""
+
+    user_id: Annotated[str, PropertyInfo(alias="userId")]
+    """User ID (optional)"""
+
+
+class Operation(TypedDict, total=False):
+    action: Required[Literal["rate", "get_due", "get_all", "get_stats"]]
+
+    card_id: Required[Annotated[str, PropertyInfo(alias="cardId")]]
+    """Flashcard ID"""
+
+    group_id: Annotated[str, PropertyInfo(alias="groupId")]
+    """Group ID (optional)"""
+
+    rating: float
+    """Rating for rate action (0-3)"""
+
+    user_id: Annotated[str, PropertyInfo(alias="userId")]
+    """User ID (optional)"""

studyfetch_sdk/types/v1/flashcard_batch_process_response.py

@@ -0,0 +1,39 @@
+# 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__ = ["FlashcardBatchProcessResponse", "Result"]
+
+
+class Result(BaseModel):
+    card_id: str = FieldInfo(alias="cardId")
+    """Flashcard ID"""
+
+    success: bool
+    """Operation success"""
+
+    error: Optional[str] = None
+    """Error message if failed"""
+
+    result: Optional[object] = None
+    """Operation result"""
+
+
+class FlashcardBatchProcessResponse(BaseModel):
+    failed: Optional[float] = None
+    """Failed operations"""
+
+    processed: Optional[float] = None
+    """Total operations processed"""
+
+    results: Optional[List[Result]] = None
+
+    success: Optional[bool] = None
+    """Overall success"""
+
+    successful: Optional[float] = None
+    """Successful operations"""

studyfetch_sdk/types/v1/flashcard_get_algorithm_info_response.py

@@ -0,0 +1,37 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List, Optional
+
+from ..._models import BaseModel
+
+__all__ = ["FlashcardGetAlgorithmInfoResponse", "Intervals", "Ratings"]
+
+
+class Intervals(BaseModel):
+    graduated: Optional[str] = None
+    """Description of graduated intervals"""
+
+    lapse: Optional[str] = None
+    """Description of lapse intervals"""
+
+    learning: Optional[List[float]] = None
+    """Learning intervals in minutes"""
+
+
+class Ratings(BaseModel):
+    description: str
+    """Rating description"""
+
+    name: str
+    """Rating name"""
+
+
+class FlashcardGetAlgorithmInfoResponse(BaseModel):
+    algorithm: Optional[str] = None
+    """Algorithm name"""
+
+    intervals: Optional[Intervals] = None
+
+    phases: Optional[Dict[str, str]] = None
+
+    ratings: Optional[Dict[str, Ratings]] = None

studyfetch_sdk/types/v1/flashcard_get_all_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__ = ["FlashcardGetAllParams"]
+
+
+class FlashcardGetAllParams(TypedDict, total=False):
+    group_id: Annotated[str, PropertyInfo(alias="groupId")]
+    """Group ID"""
+
+    limit: float
+    """Max number of cards"""
+
+    offset: float
+    """Offset"""
+
+    user_id: Annotated[str, PropertyInfo(alias="userId")]
+    """User ID"""

studyfetch_sdk/types/v1/flashcard_get_due_params.py

@@ -0,0 +1,19 @@
+# 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__ = ["FlashcardGetDueParams"]
+
+
+class FlashcardGetDueParams(TypedDict, total=False):
+    group_id: Required[Annotated[str, PropertyInfo(alias="groupId")]]
+
+    limit: float
+    """Max number of cards"""
+
+    user_id: Annotated[str, PropertyInfo(alias="userId")]
+    """User ID"""

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

studyfetch_sdk/types/v1/flashcard_get_types_response.py

@@ -0,0 +1,14 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List, Optional
+
+from ..._models import BaseModel
+
+__all__ = ["FlashcardGetTypesResponse"]
+
+
+class FlashcardGetTypesResponse(BaseModel):
+    descriptions: Optional[Dict[str, str]] = None
+
+    types: Optional[List[str]] = None
+    """List of flashcard types"""

studyfetch_sdk/types/v1/flashcard_rate_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__ = ["FlashcardRateParams"]
+
+
+class FlashcardRateParams(TypedDict, total=False):
+    card_id: Required[Annotated[str, PropertyInfo(alias="cardId")]]
+    """Flashcard ID"""
+
+    rating: Required[float]
+    """Rating (0-3)"""
+
+    group_id: Annotated[str, PropertyInfo(alias="groupId")]
+    """Group ID (optional)"""
+
+    user_id: Annotated[str, PropertyInfo(alias="userId")]
+    """User ID (optional)"""

studyfetch_sdk/types/v1/folder_create_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__ = ["FolderCreateParams"]
+
+
+class FolderCreateParams(TypedDict, total=False):
+    name: Required[str]
+    """Folder name"""
+
+    parent_id: Annotated[str, PropertyInfo(alias="parentId")]
+    """Parent folder ID (optional)"""

studyfetch_sdk/types/v1/folder_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 Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["FolderListParams"]
+
+
+class FolderListParams(TypedDict, total=False):
+    parent_id: Annotated[object, PropertyInfo(alias="parentId")]
+    """Filter by parent folder"""

studyfetch_sdk/types/v1/folder_update_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 Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["FolderUpdateParams"]
+
+
+class FolderUpdateParams(TypedDict, total=False):
+    name: str
+    """New folder name"""
+
+    parent_id: Annotated[str, PropertyInfo(alias="parentId")]
+    """New parent folder ID"""

studyfetch_sdk/types/v1/material_create_params.py

@@ -0,0 +1,34 @@
+# 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__ = ["MaterialCreateParams", "Content"]
+
+
+class MaterialCreateParams(TypedDict, total=False):
+    content: Required[Content]
+    """Content details"""
+
+    name: Required[str]
+    """Name of the material"""
+
+    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_create_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__ = ["MaterialCreateResponse", "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 MaterialCreateResponse(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/material_get_download_url_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__ = ["MaterialGetDownloadURLParams"]
+
+
+class MaterialGetDownloadURLParams(TypedDict, total=False):
+    expires_in: Required[Annotated[str, PropertyInfo(alias="expiresIn")]]

studyfetch_sdk/types/v1/material_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 Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["MaterialListParams"]
+
+
+class MaterialListParams(TypedDict, total=False):
+    folder_id: Annotated[str, PropertyInfo(alias="folderId")]
+    """Filter by folder ID"""

studyfetch_sdk/types/v1/material_list_response.py

@@ -0,0 +1,65 @@
+# 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__ = ["MaterialListResponse", "MaterialListResponseItem", "MaterialListResponseItemContent"]
+
+
+class MaterialListResponseItemContent(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 MaterialListResponseItem(BaseModel):
+    api_id: str = FieldInfo(alias="_id")
+    """Material ID"""
+
+    content: MaterialListResponseItemContent
+    """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"""
+
+
+MaterialListResponse: TypeAlias = List[MaterialListResponseItem]

studyfetch_sdk/types/v1/material_retrieve_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__ = ["MaterialRetrieveResponse", "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 MaterialRetrieveResponse(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/materials/__init__.py

@@ -0,0 +1,8 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from .upload_upload_file_params import UploadUploadFileParams as UploadUploadFileParams
+from .upload_upload_file_response import UploadUploadFileResponse as UploadUploadFileResponse
+from .upload_upload_from_url_params import UploadUploadFromURLParams as UploadUploadFromURLParams
+from .upload_upload_from_url_response import UploadUploadFromURLResponse as UploadUploadFromURLResponse

studyfetch_sdk/types/v1/materials/upload_upload_file_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 ...._types import FileTypes
+from ...._utils import PropertyInfo
+
+__all__ = ["UploadUploadFileParams"]
+
+
+class UploadUploadFileParams(TypedDict, total=False):
+    file: Required[FileTypes]
+
+    name: Required[str]
+    """Material name"""
+
+    folder_id: Annotated[str, PropertyInfo(alias="folderId")]
+    """Folder ID (optional)"""

studyfetch_sdk/types/v1/materials/upload_upload_file_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__ = ["UploadUploadFileResponse", "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 UploadUploadFileResponse(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/materials/upload_upload_from_url_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__ = ["UploadUploadFromURLParams"]
+
+
+class UploadUploadFromURLParams(TypedDict, total=False):
+    name: Required[str]
+    """Material name"""
+
+    url: Required[str]
+    """URL to fetch content from"""
+
+    folder_id: Annotated[str, PropertyInfo(alias="folderId")]
+    """Folder ID (optional)"""