mixpeek 0.8.41__py3-none-any.whl → 0.9.0__py3-none-any.whl

mixpeek_sdk/resources/collections/files.py

@@ -0,0 +1,679 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Optional
+from typing_extensions import Literal
+
+import httpx
+
+from ..._types import NOT_GIVEN, Body, Query, Headers, NotGiven
+from ..._utils import (
+    maybe_transform,
+    strip_not_given,
+    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.collections import file_full_params, file_create_params, file_update_params
+from ...types.collections.fileresponse import Fileresponse
+from ...types.collections.groupedfiledata import Groupedfiledata
+
+__all__ = ["FilesResource", "AsyncFilesResource"]
+
+
+class FilesResource(SyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> FilesResourceWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return the
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/mixpeek/python-client#accessing-raw-response-data-eg-headers
+        """
+        return FilesResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> FilesResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/mixpeek/python-client#with_streaming_response
+        """
+        return FilesResourceWithStreamingResponse(self)
+
+    def create(
+        self,
+        *,
+        collection_id: str,
+        filters: Optional[object] | NotGiven = NOT_GIVEN,
+        page: int | NotGiven = NOT_GIVEN,
+        page_size: int | NotGiven = NOT_GIVEN,
+        randomize: bool | NotGiven = NOT_GIVEN,
+        sort_by: Optional[str] | NotGiven = NOT_GIVEN,
+        sort_order: Optional[Literal["asc", "desc"]] | NotGiven = NOT_GIVEN,
+        authorization: str | NotGiven = NOT_GIVEN,
+        index_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,
+    ) -> object:
+        """
+        List Files
+
+        Args:
+          index_id: filter by organization
+
+          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 = {
+            **strip_not_given(
+                {
+                    "Authorization": authorization,
+                    "index-id": index_id,
+                }
+            ),
+            **(extra_headers or {}),
+        }
+        return self._post(
+            "/collections/files",
+            body=maybe_transform(
+                {
+                    "collection_id": collection_id,
+                    "filters": filters,
+                    "page": page,
+                    "page_size": page_size,
+                    "randomize": randomize,
+                    "sort_by": sort_by,
+                    "sort_order": sort_order,
+                },
+                file_create_params.FileCreateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=object,
+        )
+
+    def retrieve(
+        self,
+        file_id: str,
+        *,
+        authorization: str | NotGiven = NOT_GIVEN,
+        index_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,
+    ) -> Fileresponse:
+        """
+        Get File By Id
+
+        Args:
+          index_id: filter by organization
+
+          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
+        """
+        if not file_id:
+            raise ValueError(f"Expected a non-empty value for `file_id` but received {file_id!r}")
+        extra_headers = {
+            **strip_not_given(
+                {
+                    "Authorization": authorization,
+                    "index-id": index_id,
+                }
+            ),
+            **(extra_headers or {}),
+        }
+        return self._get(
+            f"/collections/file/{file_id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=Fileresponse,
+        )
+
+    def update(
+        self,
+        file_id: str,
+        *,
+        body: object,
+        authorization: str | NotGiven = NOT_GIVEN,
+        index_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,
+    ) -> Fileresponse:
+        """
+        Update File By Id
+
+        Args:
+          index_id: filter by organization
+
+          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
+        """
+        if not file_id:
+            raise ValueError(f"Expected a non-empty value for `file_id` but received {file_id!r}")
+        extra_headers = {
+            **strip_not_given(
+                {
+                    "Authorization": authorization,
+                    "index-id": index_id,
+                }
+            ),
+            **(extra_headers or {}),
+        }
+        return self._put(
+            f"/collections/file/{file_id}",
+            body=maybe_transform(body, file_update_params.FileUpdateParams),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=Fileresponse,
+        )
+
+    def delete(
+        self,
+        file_id: str,
+        *,
+        authorization: str | NotGiven = NOT_GIVEN,
+        index_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,
+    ) -> object:
+        """
+        Delete File By Id
+
+        Args:
+          index_id: filter by organization
+
+          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
+        """
+        if not file_id:
+            raise ValueError(f"Expected a non-empty value for `file_id` but received {file_id!r}")
+        extra_headers = {
+            **strip_not_given(
+                {
+                    "Authorization": authorization,
+                    "index-id": index_id,
+                }
+            ),
+            **(extra_headers or {}),
+        }
+        return self._delete(
+            f"/collections/file/{file_id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=object,
+        )
+
+    def full(
+        self,
+        file_id: str,
+        *,
+        modality: str | NotGiven = NOT_GIVEN,
+        page: int | NotGiven = NOT_GIVEN,
+        page_size: int | NotGiven = NOT_GIVEN,
+        authorization: str | NotGiven = NOT_GIVEN,
+        index_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,
+    ) -> Groupedfiledata:
+        """
+        Get File Full
+
+        Args:
+          index_id: filter by organization
+
+          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
+        """
+        if not file_id:
+            raise ValueError(f"Expected a non-empty value for `file_id` but received {file_id!r}")
+        extra_headers = {
+            **strip_not_given(
+                {
+                    "Authorization": authorization,
+                    "index-id": index_id,
+                }
+            ),
+            **(extra_headers or {}),
+        }
+        return self._get(
+            f"/collections/file/{file_id}/full",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "modality": modality,
+                        "page": page,
+                        "page_size": page_size,
+                    },
+                    file_full_params.FileFullParams,
+                ),
+            ),
+            cast_to=Groupedfiledata,
+        )
+
+
+class AsyncFilesResource(AsyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> AsyncFilesResourceWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return the
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/mixpeek/python-client#accessing-raw-response-data-eg-headers
+        """
+        return AsyncFilesResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> AsyncFilesResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/mixpeek/python-client#with_streaming_response
+        """
+        return AsyncFilesResourceWithStreamingResponse(self)
+
+    async def create(
+        self,
+        *,
+        collection_id: str,
+        filters: Optional[object] | NotGiven = NOT_GIVEN,
+        page: int | NotGiven = NOT_GIVEN,
+        page_size: int | NotGiven = NOT_GIVEN,
+        randomize: bool | NotGiven = NOT_GIVEN,
+        sort_by: Optional[str] | NotGiven = NOT_GIVEN,
+        sort_order: Optional[Literal["asc", "desc"]] | NotGiven = NOT_GIVEN,
+        authorization: str | NotGiven = NOT_GIVEN,
+        index_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,
+    ) -> object:
+        """
+        List Files
+
+        Args:
+          index_id: filter by organization
+
+          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 = {
+            **strip_not_given(
+                {
+                    "Authorization": authorization,
+                    "index-id": index_id,
+                }
+            ),
+            **(extra_headers or {}),
+        }
+        return await self._post(
+            "/collections/files",
+            body=await async_maybe_transform(
+                {
+                    "collection_id": collection_id,
+                    "filters": filters,
+                    "page": page,
+                    "page_size": page_size,
+                    "randomize": randomize,
+                    "sort_by": sort_by,
+                    "sort_order": sort_order,
+                },
+                file_create_params.FileCreateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=object,
+        )
+
+    async def retrieve(
+        self,
+        file_id: str,
+        *,
+        authorization: str | NotGiven = NOT_GIVEN,
+        index_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,
+    ) -> Fileresponse:
+        """
+        Get File By Id
+
+        Args:
+          index_id: filter by organization
+
+          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
+        """
+        if not file_id:
+            raise ValueError(f"Expected a non-empty value for `file_id` but received {file_id!r}")
+        extra_headers = {
+            **strip_not_given(
+                {
+                    "Authorization": authorization,
+                    "index-id": index_id,
+                }
+            ),
+            **(extra_headers or {}),
+        }
+        return await self._get(
+            f"/collections/file/{file_id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=Fileresponse,
+        )
+
+    async def update(
+        self,
+        file_id: str,
+        *,
+        body: object,
+        authorization: str | NotGiven = NOT_GIVEN,
+        index_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,
+    ) -> Fileresponse:
+        """
+        Update File By Id
+
+        Args:
+          index_id: filter by organization
+
+          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
+        """
+        if not file_id:
+            raise ValueError(f"Expected a non-empty value for `file_id` but received {file_id!r}")
+        extra_headers = {
+            **strip_not_given(
+                {
+                    "Authorization": authorization,
+                    "index-id": index_id,
+                }
+            ),
+            **(extra_headers or {}),
+        }
+        return await self._put(
+            f"/collections/file/{file_id}",
+            body=await async_maybe_transform(body, file_update_params.FileUpdateParams),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=Fileresponse,
+        )
+
+    async def delete(
+        self,
+        file_id: str,
+        *,
+        authorization: str | NotGiven = NOT_GIVEN,
+        index_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,
+    ) -> object:
+        """
+        Delete File By Id
+
+        Args:
+          index_id: filter by organization
+
+          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
+        """
+        if not file_id:
+            raise ValueError(f"Expected a non-empty value for `file_id` but received {file_id!r}")
+        extra_headers = {
+            **strip_not_given(
+                {
+                    "Authorization": authorization,
+                    "index-id": index_id,
+                }
+            ),
+            **(extra_headers or {}),
+        }
+        return await self._delete(
+            f"/collections/file/{file_id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=object,
+        )
+
+    async def full(
+        self,
+        file_id: str,
+        *,
+        modality: str | NotGiven = NOT_GIVEN,
+        page: int | NotGiven = NOT_GIVEN,
+        page_size: int | NotGiven = NOT_GIVEN,
+        authorization: str | NotGiven = NOT_GIVEN,
+        index_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,
+    ) -> Groupedfiledata:
+        """
+        Get File Full
+
+        Args:
+          index_id: filter by organization
+
+          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
+        """
+        if not file_id:
+            raise ValueError(f"Expected a non-empty value for `file_id` but received {file_id!r}")
+        extra_headers = {
+            **strip_not_given(
+                {
+                    "Authorization": authorization,
+                    "index-id": index_id,
+                }
+            ),
+            **(extra_headers or {}),
+        }
+        return await self._get(
+            f"/collections/file/{file_id}/full",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=await async_maybe_transform(
+                    {
+                        "modality": modality,
+                        "page": page,
+                        "page_size": page_size,
+                    },
+                    file_full_params.FileFullParams,
+                ),
+            ),
+            cast_to=Groupedfiledata,
+        )
+
+
+class FilesResourceWithRawResponse:
+    def __init__(self, files: FilesResource) -> None:
+        self._files = files
+
+        self.create = to_raw_response_wrapper(
+            files.create,
+        )
+        self.retrieve = to_raw_response_wrapper(
+            files.retrieve,
+        )
+        self.update = to_raw_response_wrapper(
+            files.update,
+        )
+        self.delete = to_raw_response_wrapper(
+            files.delete,
+        )
+        self.full = to_raw_response_wrapper(
+            files.full,
+        )
+
+
+class AsyncFilesResourceWithRawResponse:
+    def __init__(self, files: AsyncFilesResource) -> None:
+        self._files = files
+
+        self.create = async_to_raw_response_wrapper(
+            files.create,
+        )
+        self.retrieve = async_to_raw_response_wrapper(
+            files.retrieve,
+        )
+        self.update = async_to_raw_response_wrapper(
+            files.update,
+        )
+        self.delete = async_to_raw_response_wrapper(
+            files.delete,
+        )
+        self.full = async_to_raw_response_wrapper(
+            files.full,
+        )
+
+
+class FilesResourceWithStreamingResponse:
+    def __init__(self, files: FilesResource) -> None:
+        self._files = files
+
+        self.create = to_streamed_response_wrapper(
+            files.create,
+        )
+        self.retrieve = to_streamed_response_wrapper(
+            files.retrieve,
+        )
+        self.update = to_streamed_response_wrapper(
+            files.update,
+        )
+        self.delete = to_streamed_response_wrapper(
+            files.delete,
+        )
+        self.full = to_streamed_response_wrapper(
+            files.full,
+        )
+
+
+class AsyncFilesResourceWithStreamingResponse:
+    def __init__(self, files: AsyncFilesResource) -> None:
+        self._files = files
+
+        self.create = async_to_streamed_response_wrapper(
+            files.create,
+        )
+        self.retrieve = async_to_streamed_response_wrapper(
+            files.retrieve,
+        )
+        self.update = async_to_streamed_response_wrapper(
+            files.update,
+        )
+        self.delete = async_to_streamed_response_wrapper(
+            files.delete,
+        )
+        self.full = async_to_streamed_response_wrapper(
+            files.full,
+        )