studyfetch-sdk 0.1.0a18__py3-none-any.whl → 0.1.0a20__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
 
@@ -102,6 +104,7 @@ class UploadResource(SyncAPIResource):
         content_type: str,
         filename: str,
         name: str,
+        extract_images: bool | NotGiven = NOT_GIVEN,
         folder_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.
@@ -120,6 +123,8 @@ class UploadResource(SyncAPIResource):
 
           name: Display name for the material
 
+          extract_images: Whether to extract images from files
+
           folder_id: Folder ID to place the material in
 
           extra_headers: Send extra headers
@@ -137,6 +142,7 @@ class UploadResource(SyncAPIResource):
                     "content_type": content_type,
                     "filename": filename,
                     "name": name,
+                    "extract_images": extract_images,
                     "folder_id": folder_id,
                 },
                 upload_create_presigned_url_params.UploadCreatePresignedURLParams,
@@ -152,6 +158,7 @@ class UploadResource(SyncAPIResource):
         *,
         file: FileTypes,
         name: str,
+        extract_images: str | NotGiven = NOT_GIVEN,
         folder_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.
@@ -166,6 +173,8 @@ class UploadResource(SyncAPIResource):
         Args:
           name: Material name
 
+          extract_images: Whether to extract images from files (true/false, default: true)
+
           folder_id: Folder ID (optional)
 
           extra_headers: Send extra headers
@@ -180,6 +189,7 @@ class UploadResource(SyncAPIResource):
             {
                 "file": file,
                 "name": name,
+                "extract_images": extract_images,
                 "folder_id": folder_id,
             }
         )
@@ -198,6 +208,71 @@ class UploadResource(SyncAPIResource):
             cast_to=Material,
         )
 
+    def upload_file_and_process(
+        self,
+        *,
+        file: FileTypes,
+        name: str,
+        extract_images: str | NotGiven = NOT_GIVEN,
+        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
+
+          extract_images: Whether to extract images from files (true/false, default: true)
+
+          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,
+                "extract_images": extract_images,
+                "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 +320,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
@@ -319,6 +450,7 @@ class AsyncUploadResource(AsyncAPIResource):
         content_type: str,
         filename: str,
         name: str,
+        extract_images: bool | NotGiven = NOT_GIVEN,
         folder_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.
@@ -337,6 +469,8 @@ class AsyncUploadResource(AsyncAPIResource):
 
           name: Display name for the material
 
+          extract_images: Whether to extract images from files
+
           folder_id: Folder ID to place the material in
 
           extra_headers: Send extra headers
@@ -354,6 +488,7 @@ class AsyncUploadResource(AsyncAPIResource):
                     "content_type": content_type,
                     "filename": filename,
                     "name": name,
+                    "extract_images": extract_images,
                     "folder_id": folder_id,
                 },
                 upload_create_presigned_url_params.UploadCreatePresignedURLParams,
@@ -369,6 +504,7 @@ class AsyncUploadResource(AsyncAPIResource):
         *,
         file: FileTypes,
         name: str,
+        extract_images: str | NotGiven = NOT_GIVEN,
         folder_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.
@@ -383,6 +519,8 @@ class AsyncUploadResource(AsyncAPIResource):
         Args:
           name: Material name
 
+          extract_images: Whether to extract images from files (true/false, default: true)
+
           folder_id: Folder ID (optional)
 
           extra_headers: Send extra headers
@@ -397,6 +535,7 @@ class AsyncUploadResource(AsyncAPIResource):
             {
                 "file": file,
                 "name": name,
+                "extract_images": extract_images,
                 "folder_id": folder_id,
             }
         )
@@ -415,6 +554,73 @@ class AsyncUploadResource(AsyncAPIResource):
             cast_to=Material,
         )
 
+    async def upload_file_and_process(
+        self,
+        *,
+        file: FileTypes,
+        name: str,
+        extract_images: str | NotGiven = NOT_GIVEN,
+        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
+
+          extract_images: Whether to extract images from files (true/false, default: true)
+
+          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,
+                "extract_images": extract_images,
+                "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 +668,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 +738,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 +762,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 +786,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 +810,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,
+        )