studyfetch-sdk 0.1.0a13__py3-none-any.whl → 0.1.0a15__py3-none-any.whl

studyfetch_sdk/resources/v1/usage/analyst.py

@@ -0,0 +1,354 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal
+
+import httpx
+
+from ...._types import NOT_GIVEN, Body, Query, Headers, NoneType, NotGiven
+from ...._utils import maybe_transform, async_maybe_transform
+from ...._compat import cached_property
+from ...._resource import SyncAPIResource, AsyncAPIResource
+from ...._response import (
+    to_raw_response_wrapper,
+    to_streamed_response_wrapper,
+    async_to_raw_response_wrapper,
+    async_to_streamed_response_wrapper,
+)
+from ...._base_client import make_request_options
+from ....types.v1.usage import analyst_list_events_params
+
+__all__ = ["AnalystResource", "AsyncAnalystResource"]
+
+
+class AnalystResource(SyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> AnalystResourceWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/GoStudyFetchGo/studyfetch-sdk-python#accessing-raw-response-data-eg-headers
+        """
+        return AnalystResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> AnalystResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/GoStudyFetchGo/studyfetch-sdk-python#with_streaming_response
+        """
+        return AnalystResourceWithStreamingResponse(self)
+
+    def get_test_questions(
+        self,
+        *,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> None:
+        """Get test results for users and groups in JWT"""
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        return self._get(
+            "/api/v1/usage-analyst/test-questions",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=NoneType,
+        )
+
+    def list_chat_messages(
+        self,
+        *,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> None:
+        """Get chat messages for users and groups in JWT"""
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        return self._get(
+            "/api/v1/usage-analyst/chat-messages",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=NoneType,
+        )
+
+    def list_events(
+        self,
+        *,
+        end_date: str,
+        event_type: 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",
+            "assignment_grader_create",
+            "api_call",
+            "cache_hit",
+            "sso_login",
+            "sso_logout",
+            "student_performance",
+        ],
+        start_date: str,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> None:
+        """
+        Get all events based on filters
+
+        Args:
+          end_date: End date for filtering (ISO 8601)
+
+          event_type: Type of usage event to filter
+
+          start_date: Start date for filtering (ISO 8601)
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        return self._get(
+            "/api/v1/usage-analyst/events",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "end_date": end_date,
+                        "event_type": event_type,
+                        "start_date": start_date,
+                    },
+                    analyst_list_events_params.AnalystListEventsParams,
+                ),
+            ),
+            cast_to=NoneType,
+        )
+
+
+class AsyncAnalystResource(AsyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> AsyncAnalystResourceWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/GoStudyFetchGo/studyfetch-sdk-python#accessing-raw-response-data-eg-headers
+        """
+        return AsyncAnalystResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> AsyncAnalystResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/GoStudyFetchGo/studyfetch-sdk-python#with_streaming_response
+        """
+        return AsyncAnalystResourceWithStreamingResponse(self)
+
+    async def get_test_questions(
+        self,
+        *,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> None:
+        """Get test results for users and groups in JWT"""
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        return await self._get(
+            "/api/v1/usage-analyst/test-questions",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=NoneType,
+        )
+
+    async def list_chat_messages(
+        self,
+        *,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> None:
+        """Get chat messages for users and groups in JWT"""
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        return await self._get(
+            "/api/v1/usage-analyst/chat-messages",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=NoneType,
+        )
+
+    async def list_events(
+        self,
+        *,
+        end_date: str,
+        event_type: 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",
+            "assignment_grader_create",
+            "api_call",
+            "cache_hit",
+            "sso_login",
+            "sso_logout",
+            "student_performance",
+        ],
+        start_date: str,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> None:
+        """
+        Get all events based on filters
+
+        Args:
+          end_date: End date for filtering (ISO 8601)
+
+          event_type: Type of usage event to filter
+
+          start_date: Start date for filtering (ISO 8601)
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        return await self._get(
+            "/api/v1/usage-analyst/events",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=await async_maybe_transform(
+                    {
+                        "end_date": end_date,
+                        "event_type": event_type,
+                        "start_date": start_date,
+                    },
+                    analyst_list_events_params.AnalystListEventsParams,
+                ),
+            ),
+            cast_to=NoneType,
+        )
+
+
+class AnalystResourceWithRawResponse:
+    def __init__(self, analyst: AnalystResource) -> None:
+        self._analyst = analyst
+
+        self.get_test_questions = to_raw_response_wrapper(
+            analyst.get_test_questions,
+        )
+        self.list_chat_messages = to_raw_response_wrapper(
+            analyst.list_chat_messages,
+        )
+        self.list_events = to_raw_response_wrapper(
+            analyst.list_events,
+        )
+
+
+class AsyncAnalystResourceWithRawResponse:
+    def __init__(self, analyst: AsyncAnalystResource) -> None:
+        self._analyst = analyst
+
+        self.get_test_questions = async_to_raw_response_wrapper(
+            analyst.get_test_questions,
+        )
+        self.list_chat_messages = async_to_raw_response_wrapper(
+            analyst.list_chat_messages,
+        )
+        self.list_events = async_to_raw_response_wrapper(
+            analyst.list_events,
+        )
+
+
+class AnalystResourceWithStreamingResponse:
+    def __init__(self, analyst: AnalystResource) -> None:
+        self._analyst = analyst
+
+        self.get_test_questions = to_streamed_response_wrapper(
+            analyst.get_test_questions,
+        )
+        self.list_chat_messages = to_streamed_response_wrapper(
+            analyst.list_chat_messages,
+        )
+        self.list_events = to_streamed_response_wrapper(
+            analyst.list_events,
+        )
+
+
+class AsyncAnalystResourceWithStreamingResponse:
+    def __init__(self, analyst: AsyncAnalystResource) -> None:
+        self._analyst = analyst
+
+        self.get_test_questions = async_to_streamed_response_wrapper(
+            analyst.get_test_questions,
+        )
+        self.list_chat_messages = async_to_streamed_response_wrapper(
+            analyst.list_chat_messages,
+        )
+        self.list_events = async_to_streamed_response_wrapper(
+            analyst.list_events,
+        )

studyfetch_sdk/resources/v1/{usage.py → usage/usage.py}

@@ -6,23 +6,35 @@ from typing_extensions import Literal
 
 import httpx
 
-from ..._types import NOT_GIVEN, Body, Query, Headers, NoneType, NotGiven
-from ..._utils import maybe_transform, async_maybe_transform
-from ..._compat import cached_property
-from ...types.v1 import usage_get_stats_params, usage_get_summary_params, usage_list_events_params
-from ..._resource import SyncAPIResource, AsyncAPIResource
-from ..._response import (
+from .analyst import (
+    AnalystResource,
+    AsyncAnalystResource,
+    AnalystResourceWithRawResponse,
+    AsyncAnalystResourceWithRawResponse,
+    AnalystResourceWithStreamingResponse,
+    AsyncAnalystResourceWithStreamingResponse,
+)
+from ...._types import NOT_GIVEN, Body, Query, Headers, NoneType, NotGiven
+from ...._utils import maybe_transform, async_maybe_transform
+from ...._compat import cached_property
+from ....types.v1 import usage_get_stats_params, usage_get_summary_params, usage_list_events_params
+from ...._resource import SyncAPIResource, AsyncAPIResource
+from ...._response import (
     to_raw_response_wrapper,
     to_streamed_response_wrapper,
     async_to_raw_response_wrapper,
     async_to_streamed_response_wrapper,
 )
-from ..._base_client import make_request_options
+from ...._base_client import make_request_options
 
 __all__ = ["UsageResource", "AsyncUsageResource"]
 
 
 class UsageResource(SyncAPIResource):
+    @cached_property
+    def analyst(self) -> AnalystResource:
+        return AnalystResource(self._client)
+
     @cached_property
     def with_raw_response(self) -> UsageResourceWithRawResponse:
         """
@@ -250,6 +262,10 @@ class UsageResource(SyncAPIResource):
 
 
 class AsyncUsageResource(AsyncAPIResource):
+    @cached_property
+    def analyst(self) -> AsyncAnalystResource:
+        return AsyncAnalystResource(self._client)
+
     @cached_property
     def with_raw_response(self) -> AsyncUsageResourceWithRawResponse:
         """
@@ -490,6 +506,10 @@ class UsageResourceWithRawResponse:
             usage.list_events,
         )
 
+    @cached_property
+    def analyst(self) -> AnalystResourceWithRawResponse:
+        return AnalystResourceWithRawResponse(self._usage.analyst)
+
 
 class AsyncUsageResourceWithRawResponse:
     def __init__(self, usage: AsyncUsageResource) -> None:
@@ -505,6 +525,10 @@ class AsyncUsageResourceWithRawResponse:
             usage.list_events,
         )
 
+    @cached_property
+    def analyst(self) -> AsyncAnalystResourceWithRawResponse:
+        return AsyncAnalystResourceWithRawResponse(self._usage.analyst)
+
 
 class UsageResourceWithStreamingResponse:
     def __init__(self, usage: UsageResource) -> None:
@@ -520,6 +544,10 @@ class UsageResourceWithStreamingResponse:
             usage.list_events,
         )
 
+    @cached_property
+    def analyst(self) -> AnalystResourceWithStreamingResponse:
+        return AnalystResourceWithStreamingResponse(self._usage.analyst)
+
 
 class AsyncUsageResourceWithStreamingResponse:
     def __init__(self, usage: AsyncUsageResource) -> None:
@@ -534,3 +562,7 @@ class AsyncUsageResourceWithStreamingResponse:
         self.list_events = async_to_streamed_response_wrapper(
             usage.list_events,
         )
+
+    @cached_property
+    def analyst(self) -> AsyncAnalystResourceWithStreamingResponse:
+        return AsyncAnalystResourceWithStreamingResponse(self._usage.analyst)

studyfetch_sdk/resources/v1/v1.py

@@ -2,14 +2,6 @@
 
 from __future__ import annotations
 
-from .usage import (
-    UsageResource,
-    AsyncUsageResource,
-    UsageResourceWithRawResponse,
-    AsyncUsageResourceWithRawResponse,
-    UsageResourceWithStreamingResponse,
-    AsyncUsageResourceWithStreamingResponse,
-)
 from .folders import (
     FoldersResource,
     AsyncFoldersResource,
@@ -68,6 +60,14 @@ from .tests.tests import (
     TestsResourceWithStreamingResponse,
     AsyncTestsResourceWithStreamingResponse,
 )
+from .usage.usage import (
+    UsageResource,
+    AsyncUsageResource,
+    UsageResourceWithRawResponse,
+    AsyncUsageResourceWithRawResponse,
+    UsageResourceWithStreamingResponse,
+    AsyncUsageResourceWithStreamingResponse,
+)
 from .upload.upload import (
     UploadResource,
     AsyncUploadResource,

studyfetch_sdk/types/v1/__init__.py

@@ -18,6 +18,7 @@ from .flashcard_rate_params import FlashcardRateParams as FlashcardRateParams
 from .embed_get_theme_params import EmbedGetThemeParams as EmbedGetThemeParams
 from .material_create_params import MaterialCreateParams as MaterialCreateParams
 from .material_list_response import MaterialListResponse as MaterialListResponse
+from .material_search_params import MaterialSearchParams as MaterialSearchParams
 from .scenario_create_params import ScenarioCreateParams as ScenarioCreateParams
 from .scenario_update_params import ScenarioUpdateParams as ScenarioUpdateParams
 from .usage_get_stats_params import UsageGetStatsParams as UsageGetStatsParams

studyfetch_sdk/types/v1/component_create_params.py

@@ -31,9 +31,6 @@ class ComponentCreateParams(TypedDict, total=False):
     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"]
     ]

studyfetch_sdk/types/v1/material_search_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 import List
+from typing_extensions import Required, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["MaterialSearchParams"]
+
+
+class MaterialSearchParams(TypedDict, total=False):
+    query: Required[str]
+    """Search query"""
+
+    folder_ids: Annotated[List[str], PropertyInfo(alias="folderIds")]
+    """
+    Optional: Limit search to materials within specific folders (includes
+    subfolders)
+    """
+
+    material_ids: Annotated[List[str], PropertyInfo(alias="materialIds")]
+    """Optional: Limit search to specific material IDs"""
+
+    top_k: Annotated[float, PropertyInfo(alias="topK")]
+    """Number of results to return (default: 5)"""

studyfetch_sdk/types/v1/upload/__init__.py

@@ -1,3 +1,9 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 from __future__ import annotations
+
+from .component_upload_url_params import ComponentUploadURLParams as ComponentUploadURLParams
+from .component_upload_file_params import ComponentUploadFileParams as ComponentUploadFileParams
+from .component_complete_upload_params import ComponentCompleteUploadParams as ComponentCompleteUploadParams
+from .component_get_presigned_url_params import ComponentGetPresignedURLParams as ComponentGetPresignedURLParams
+from .component_get_presigned_url_response import ComponentGetPresignedURLResponse as ComponentGetPresignedURLResponse

studyfetch_sdk/types/v1/upload/component_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__ = ["ComponentCompleteUploadParams"]
+
+
+class ComponentCompleteUploadParams(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"""

studyfetch_sdk/types/v1/upload/component_get_presigned_url_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__ = ["ComponentGetPresignedURLParams"]
+
+
+class ComponentGetPresignedURLParams(TypedDict, total=False):
+    content_type: Required[Annotated[str, PropertyInfo(alias="contentType")]]
+    """The MIME type of the file"""
+
+    filename: Required[str]
+    """The name of the file to upload"""
+
+    folder_id: Required[Annotated[str, PropertyInfo(alias="folderId")]]
+    """The ID of the folder to upload to"""
+
+    organization_id: Required[Annotated[str, PropertyInfo(alias="organizationId")]]
+    """The ID of the organization"""

studyfetch_sdk/types/v1/upload/component_get_presigned_url_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__ = ["ComponentGetPresignedURLResponse"]
+
+
+class ComponentGetPresignedURLResponse(BaseModel):
+    key: str
+    """The S3 key for the file"""
+
+    upload_url: str = FieldInfo(alias="uploadUrl")
+    """The presigned URL for uploading"""

studyfetch_sdk/types/v1/upload/component_upload_file_params.py

@@ -0,0 +1,21 @@
+# 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__ = ["ComponentUploadFileParams"]
+
+
+class ComponentUploadFileParams(TypedDict, total=False):
+    file: Required[FileTypes]
+    """The file to upload"""
+
+    folder_id: Required[Annotated[str, PropertyInfo(alias="folderId")]]
+    """The ID of the folder to upload to"""
+
+    organization_id: Required[Annotated[str, PropertyInfo(alias="organizationId")]]
+    """The ID of the organization"""

studyfetch_sdk/types/v1/upload/component_upload_url_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__ = ["ComponentUploadURLParams"]
+
+
+class ComponentUploadURLParams(TypedDict, total=False):
+    folder_id: Required[Annotated[str, PropertyInfo(alias="folderId")]]
+    """The ID of the folder to upload to"""
+
+    name: Required[str]
+    """The name for the uploaded file"""
+
+    organization_id: Required[Annotated[str, PropertyInfo(alias="organizationId")]]
+    """The ID of the organization"""
+
+    url: Required[str]
+    """The URL of the file to upload"""

studyfetch_sdk/types/v1/usage/__init__.py

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