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

studyfetch_sdk/resources/v1/materials/upload.py

@@ -6,7 +6,7 @@ from typing import Mapping, cast
 
 import httpx
 
-from ...._types import NOT_GIVEN, Body, Query, Headers, NoneType, NotGiven, FileTypes
+from ...._types import NOT_GIVEN, Body, Query, Headers, NotGiven, FileTypes
 from ...._utils import extract_files, maybe_transform, deepcopy_minimal, async_maybe_transform
 from ...._compat import cached_property
 from ...._resource import SyncAPIResource, AsyncAPIResource
@@ -18,7 +18,15 @@ from ...._response import (
 )
 from ...._base_client import make_request_options
 from ....types.v1.material import Material
-from ....types.v1.materials import upload_upload_file_params, upload_upload_from_url_params
+from ....types.v1.materials import (
+    upload_upload_file_params,
+    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
 
 __all__ = ["UploadResource", "AsyncUploadResource"]
 
@@ -46,39 +54,99 @@ class UploadResource(SyncAPIResource):
     def complete_upload(
         self,
         *,
+        material_id: str,
+        organization_id: str,
+        s3_key: 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:
-        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+    ) -> Material:
+        """
+        Complete upload after using presigned URL
+
+        Args:
+          material_id: The ID of the material that was uploaded
+
+          organization_id: The ID of the organization
+
+          s3_key: The S3 key of the uploaded file
+
+          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/complete",
+            body=maybe_transform(
+                {
+                    "material_id": material_id,
+                    "organization_id": organization_id,
+                    "s3_key": s3_key,
+                },
+                upload_complete_upload_params.UploadCompleteUploadParams,
+            ),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=NoneType,
+            cast_to=Material,
         )
 
     def create_presigned_url(
         self,
         *,
+        content_type: str,
+        filename: str,
+        name: str,
+        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.
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> None:
-        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+    ) -> UploadCreatePresignedURLResponse:
+        """
+        Get presigned URL for direct S3 upload
+
+        Args:
+          content_type: MIME type of the file
+
+          filename: Filename to upload
+
+          name: Display name for the material
+
+          folder_id: Folder ID to place the material in
+
+          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/presigned-url",
+            body=maybe_transform(
+                {
+                    "content_type": content_type,
+                    "filename": filename,
+                    "name": name,
+                    "folder_id": folder_id,
+                },
+                upload_create_presigned_url_params.UploadCreatePresignedURLParams,
+            ),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=NoneType,
+            cast_to=UploadCreatePresignedURLResponse,
         )
 
     def upload_file(
@@ -132,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,
         *,
@@ -179,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
@@ -203,39 +388,99 @@ class AsyncUploadResource(AsyncAPIResource):
     async def complete_upload(
         self,
         *,
+        material_id: str,
+        organization_id: str,
+        s3_key: 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:
-        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+    ) -> Material:
+        """
+        Complete upload after using presigned URL
+
+        Args:
+          material_id: The ID of the material that was uploaded
+
+          organization_id: The ID of the organization
+
+          s3_key: The S3 key of the uploaded file
+
+          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/complete",
+            body=await async_maybe_transform(
+                {
+                    "material_id": material_id,
+                    "organization_id": organization_id,
+                    "s3_key": s3_key,
+                },
+                upload_complete_upload_params.UploadCompleteUploadParams,
+            ),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=NoneType,
+            cast_to=Material,
         )
 
     async def create_presigned_url(
         self,
         *,
+        content_type: str,
+        filename: str,
+        name: str,
+        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.
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> None:
-        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+    ) -> UploadCreatePresignedURLResponse:
+        """
+        Get presigned URL for direct S3 upload
+
+        Args:
+          content_type: MIME type of the file
+
+          filename: Filename to upload
+
+          name: Display name for the material
+
+          folder_id: Folder ID to place the material in
+
+          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/presigned-url",
+            body=await async_maybe_transform(
+                {
+                    "content_type": content_type,
+                    "filename": filename,
+                    "name": name,
+                    "folder_id": folder_id,
+                },
+                upload_create_presigned_url_params.UploadCreatePresignedURLParams,
+            ),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=NoneType,
+            cast_to=UploadCreatePresignedURLResponse,
         )
 
     async def upload_file(
@@ -289,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,
         *,
@@ -336,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:
@@ -350,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:
@@ -368,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:
@@ -386,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:
@@ -404,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,
+        )