studyfetch-sdk 0.1.0a18__py3-none-any.whl → 0.1.0a19__py3-none-any.whl

studyfetch_sdk/resources/v1/materials/upload.py

@@ -23,6 +23,8 @@ from ....types.v1.materials import (
     upload_complete_upload_params,
     upload_upload_from_url_params,
     upload_create_presigned_url_params,
+    upload_upload_url_and_process_params,
+    upload_upload_file_and_process_params,
 )
 from ....types.v1.materials.upload_create_presigned_url_response import UploadCreatePresignedURLResponse
 
@@ -198,6 +200,67 @@ class UploadResource(SyncAPIResource):
             cast_to=Material,
         )
 
+    def upload_file_and_process(
+        self,
+        *,
+        file: FileTypes,
+        name: str,
+        folder_id: str | NotGiven = NOT_GIVEN,
+        poll_interval_ms: float | NotGiven = NOT_GIVEN,
+        timeout_ms: float | NotGiven = NOT_GIVEN,
+        # 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,
+    ) -> Material:
+        """Uploads a file and waits for processing to finish before returning.
+
+        Useful for
+        synchronous API usage.
+
+        Args:
+          name: Material name
+
+          folder_id: Folder ID (optional)
+
+          poll_interval_ms: Polling interval in milliseconds (default: 2000)
+
+          timeout_ms: Processing timeout in milliseconds (default: 300000)
+
+          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
+        """
+        body = deepcopy_minimal(
+            {
+                "file": file,
+                "name": name,
+                "folder_id": folder_id,
+                "poll_interval_ms": poll_interval_ms,
+                "timeout_ms": timeout_ms,
+            }
+        )
+        files = extract_files(cast(Mapping[str, object], body), paths=[["file"]])
+        # It should be noted that the actual Content-Type header that will be
+        # sent to the server will contain a `boundary` parameter, e.g.
+        # multipart/form-data; boundary=---abc--
+        extra_headers = {"Content-Type": "multipart/form-data", **(extra_headers or {})}
+        return self._post(
+            "/api/v1/materials/upload/file-and-process",
+            body=maybe_transform(body, upload_upload_file_and_process_params.UploadUploadFileAndProcessParams),
+            files=files,
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=Material,
+        )
+
     def upload_from_url(
         self,
         *,
@@ -245,6 +308,62 @@ class UploadResource(SyncAPIResource):
             cast_to=Material,
         )
 
+    def upload_url_and_process(
+        self,
+        *,
+        name: str,
+        url: str,
+        folder_id: str | NotGiven = NOT_GIVEN,
+        poll_interval_ms: float | NotGiven = NOT_GIVEN,
+        timeout_ms: float | NotGiven = NOT_GIVEN,
+        # 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,
+    ) -> Material:
+        """
+        Fetches content from URL and waits for processing to finish before returning.
+        Useful for synchronous API usage.
+
+        Args:
+          name: Material name
+
+          url: URL to fetch content from
+
+          folder_id: Folder ID (optional)
+
+          poll_interval_ms: Polling interval in milliseconds (default: 2 seconds)
+
+          timeout_ms: Maximum time to wait for processing in milliseconds (default: 5 minutes)
+
+          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
+        """
+        return self._post(
+            "/api/v1/materials/upload/url-and-process",
+            body=maybe_transform(
+                {
+                    "name": name,
+                    "url": url,
+                    "folder_id": folder_id,
+                    "poll_interval_ms": poll_interval_ms,
+                    "timeout_ms": timeout_ms,
+                },
+                upload_upload_url_and_process_params.UploadUploadURLAndProcessParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=Material,
+        )
+
 
 class AsyncUploadResource(AsyncAPIResource):
     @cached_property
@@ -415,6 +534,69 @@ class AsyncUploadResource(AsyncAPIResource):
             cast_to=Material,
         )
 
+    async def upload_file_and_process(
+        self,
+        *,
+        file: FileTypes,
+        name: str,
+        folder_id: str | NotGiven = NOT_GIVEN,
+        poll_interval_ms: float | NotGiven = NOT_GIVEN,
+        timeout_ms: float | NotGiven = NOT_GIVEN,
+        # 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,
+    ) -> Material:
+        """Uploads a file and waits for processing to finish before returning.
+
+        Useful for
+        synchronous API usage.
+
+        Args:
+          name: Material name
+
+          folder_id: Folder ID (optional)
+
+          poll_interval_ms: Polling interval in milliseconds (default: 2000)
+
+          timeout_ms: Processing timeout in milliseconds (default: 300000)
+
+          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
+        """
+        body = deepcopy_minimal(
+            {
+                "file": file,
+                "name": name,
+                "folder_id": folder_id,
+                "poll_interval_ms": poll_interval_ms,
+                "timeout_ms": timeout_ms,
+            }
+        )
+        files = extract_files(cast(Mapping[str, object], body), paths=[["file"]])
+        # It should be noted that the actual Content-Type header that will be
+        # sent to the server will contain a `boundary` parameter, e.g.
+        # multipart/form-data; boundary=---abc--
+        extra_headers = {"Content-Type": "multipart/form-data", **(extra_headers or {})}
+        return await self._post(
+            "/api/v1/materials/upload/file-and-process",
+            body=await async_maybe_transform(
+                body, upload_upload_file_and_process_params.UploadUploadFileAndProcessParams
+            ),
+            files=files,
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=Material,
+        )
+
     async def upload_from_url(
         self,
         *,
@@ -462,6 +644,62 @@ class AsyncUploadResource(AsyncAPIResource):
             cast_to=Material,
         )
 
+    async def upload_url_and_process(
+        self,
+        *,
+        name: str,
+        url: str,
+        folder_id: str | NotGiven = NOT_GIVEN,
+        poll_interval_ms: float | NotGiven = NOT_GIVEN,
+        timeout_ms: float | NotGiven = NOT_GIVEN,
+        # 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,
+    ) -> Material:
+        """
+        Fetches content from URL and waits for processing to finish before returning.
+        Useful for synchronous API usage.
+
+        Args:
+          name: Material name
+
+          url: URL to fetch content from
+
+          folder_id: Folder ID (optional)
+
+          poll_interval_ms: Polling interval in milliseconds (default: 2 seconds)
+
+          timeout_ms: Maximum time to wait for processing in milliseconds (default: 5 minutes)
+
+          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
+        """
+        return await self._post(
+            "/api/v1/materials/upload/url-and-process",
+            body=await async_maybe_transform(
+                {
+                    "name": name,
+                    "url": url,
+                    "folder_id": folder_id,
+                    "poll_interval_ms": poll_interval_ms,
+                    "timeout_ms": timeout_ms,
+                },
+                upload_upload_url_and_process_params.UploadUploadURLAndProcessParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=Material,
+        )
+
 
 class UploadResourceWithRawResponse:
     def __init__(self, upload: UploadResource) -> None:
@@ -476,9 +714,15 @@ class UploadResourceWithRawResponse:
         self.upload_file = to_raw_response_wrapper(
             upload.upload_file,
         )
+        self.upload_file_and_process = to_raw_response_wrapper(
+            upload.upload_file_and_process,
+        )
         self.upload_from_url = to_raw_response_wrapper(
             upload.upload_from_url,
         )
+        self.upload_url_and_process = to_raw_response_wrapper(
+            upload.upload_url_and_process,
+        )
 
 
 class AsyncUploadResourceWithRawResponse:
@@ -494,9 +738,15 @@ class AsyncUploadResourceWithRawResponse:
         self.upload_file = async_to_raw_response_wrapper(
             upload.upload_file,
         )
+        self.upload_file_and_process = async_to_raw_response_wrapper(
+            upload.upload_file_and_process,
+        )
         self.upload_from_url = async_to_raw_response_wrapper(
             upload.upload_from_url,
         )
+        self.upload_url_and_process = async_to_raw_response_wrapper(
+            upload.upload_url_and_process,
+        )
 
 
 class UploadResourceWithStreamingResponse:
@@ -512,9 +762,15 @@ class UploadResourceWithStreamingResponse:
         self.upload_file = to_streamed_response_wrapper(
             upload.upload_file,
         )
+        self.upload_file_and_process = to_streamed_response_wrapper(
+            upload.upload_file_and_process,
+        )
         self.upload_from_url = to_streamed_response_wrapper(
             upload.upload_from_url,
         )
+        self.upload_url_and_process = to_streamed_response_wrapper(
+            upload.upload_url_and_process,
+        )
 
 
 class AsyncUploadResourceWithStreamingResponse:
@@ -530,6 +786,12 @@ class AsyncUploadResourceWithStreamingResponse:
         self.upload_file = async_to_streamed_response_wrapper(
             upload.upload_file,
         )
+        self.upload_file_and_process = async_to_streamed_response_wrapper(
+            upload.upload_file_and_process,
+        )
         self.upload_from_url = async_to_streamed_response_wrapper(
             upload.upload_from_url,
         )
+        self.upload_url_and_process = async_to_streamed_response_wrapper(
+            upload.upload_url_and_process,
+        )

studyfetch_sdk/resources/v1/usage/analyst.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 
+from typing import List
 from typing_extensions import Literal
 
 import httpx
@@ -17,7 +18,12 @@ from ...._response import (
     async_to_streamed_response_wrapper,
 )
 from ...._base_client import make_request_options
-from ....types.v1.usage import analyst_list_events_params
+from ....types.v1.usage import (
+    analyst_list_events_params,
+    analyst_get_test_questions_params,
+    analyst_list_chat_messages_params,
+)
+from ....types.v1.usage.analyst_list_chat_messages_response import AnalystListChatMessagesResponse
 
 __all__ = ["AnalystResource", "AsyncAnalystResource"]
 
@@ -45,6 +51,8 @@ class AnalystResource(SyncAPIResource):
     def get_test_questions(
         self,
         *,
+        group_ids: List[str] | NotGiven = NOT_GIVEN,
+        user_id: str | NotGiven = NOT_GIVEN,
         # 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,
@@ -52,12 +60,37 @@ class AnalystResource(SyncAPIResource):
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> None:
-        """Get test results for users and groups in JWT"""
+        """
+        Get test results with full question data for user or group
+
+        Args:
+          group_ids: Array of group IDs to filter
+
+          user_id: User ID to get test results for
+
+          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/test-questions",
             options=make_request_options(
-                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "group_ids": group_ids,
+                        "user_id": user_id,
+                    },
+                    analyst_get_test_questions_params.AnalystGetTestQuestionsParams,
+                ),
             ),
             cast_to=NoneType,
         )
@@ -65,21 +98,47 @@ class AnalystResource(SyncAPIResource):
     def list_chat_messages(
         self,
         *,
+        group_ids: List[str] | NotGiven = NOT_GIVEN,
+        user_id: str | NotGiven = NOT_GIVEN,
         # 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 {})}
+    ) -> AnalystListChatMessagesResponse:
+        """
+        Get all chat messages from sessions for user or group
+
+        Args:
+          group_ids: Array of group IDs to filter
+
+          user_id: User ID to get chat messages for
+
+          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
+        """
         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
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "group_ids": group_ids,
+                        "user_id": user_id,
+                    },
+                    analyst_list_chat_messages_params.AnalystListChatMessagesParams,
+                ),
             ),
-            cast_to=NoneType,
+            cast_to=AnalystListChatMessagesResponse,
         )
 
     def list_events(
@@ -112,6 +171,8 @@ class AnalystResource(SyncAPIResource):
             "student_performance",
         ],
         start_date: str,
+        group_ids: List[str] | NotGiven = NOT_GIVEN,
+        user_ids: List[str] | NotGiven = NOT_GIVEN,
         # 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,
@@ -129,6 +190,10 @@ class AnalystResource(SyncAPIResource):
 
           start_date: Start date for filtering (ISO 8601)
 
+          group_ids: Array of group IDs to filter
+
+          user_ids: Array of user IDs to filter
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -150,6 +215,8 @@ class AnalystResource(SyncAPIResource):
                         "end_date": end_date,
                         "event_type": event_type,
                         "start_date": start_date,
+                        "group_ids": group_ids,
+                        "user_ids": user_ids,
                     },
                     analyst_list_events_params.AnalystListEventsParams,
                 ),
@@ -181,6 +248,8 @@ class AsyncAnalystResource(AsyncAPIResource):
     async def get_test_questions(
         self,
         *,
+        group_ids: List[str] | NotGiven = NOT_GIVEN,
+        user_id: str | NotGiven = NOT_GIVEN,
         # 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,
@@ -188,12 +257,37 @@ class AsyncAnalystResource(AsyncAPIResource):
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> None:
-        """Get test results for users and groups in JWT"""
+        """
+        Get test results with full question data for user or group
+
+        Args:
+          group_ids: Array of group IDs to filter
+
+          user_id: User ID to get test results for
+
+          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/test-questions",
             options=make_request_options(
-                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=await async_maybe_transform(
+                    {
+                        "group_ids": group_ids,
+                        "user_id": user_id,
+                    },
+                    analyst_get_test_questions_params.AnalystGetTestQuestionsParams,
+                ),
             ),
             cast_to=NoneType,
         )
@@ -201,21 +295,47 @@ class AsyncAnalystResource(AsyncAPIResource):
     async def list_chat_messages(
         self,
         *,
+        group_ids: List[str] | NotGiven = NOT_GIVEN,
+        user_id: str | NotGiven = NOT_GIVEN,
         # 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 {})}
+    ) -> AnalystListChatMessagesResponse:
+        """
+        Get all chat messages from sessions for user or group
+
+        Args:
+          group_ids: Array of group IDs to filter
+
+          user_id: User ID to get chat messages for
+
+          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
+        """
         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
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=await async_maybe_transform(
+                    {
+                        "group_ids": group_ids,
+                        "user_id": user_id,
+                    },
+                    analyst_list_chat_messages_params.AnalystListChatMessagesParams,
+                ),
             ),
-            cast_to=NoneType,
+            cast_to=AnalystListChatMessagesResponse,
         )
 
     async def list_events(
@@ -248,6 +368,8 @@ class AsyncAnalystResource(AsyncAPIResource):
             "student_performance",
         ],
         start_date: str,
+        group_ids: List[str] | NotGiven = NOT_GIVEN,
+        user_ids: List[str] | NotGiven = NOT_GIVEN,
         # 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,
@@ -265,6 +387,10 @@ class AsyncAnalystResource(AsyncAPIResource):
 
           start_date: Start date for filtering (ISO 8601)
 
+          group_ids: Array of group IDs to filter
+
+          user_ids: Array of user IDs to filter
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -286,6 +412,8 @@ class AsyncAnalystResource(AsyncAPIResource):
                         "end_date": end_date,
                         "event_type": event_type,
                         "start_date": start_date,
+                        "group_ids": group_ids,
+                        "user_ids": user_ids,
                     },
                     analyst_list_events_params.AnalystListEventsParams,
                 ),