hubmap-search-sdk 1.0.0a1__py3-none-any.whl

hubmap_search_sdk/resources/mget.py

@@ -0,0 +1,265 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+import httpx
+
+from ..types import mget_retrieve_multiple_params, mget_retrieve_multiple_by_index_params
+from .._types import NOT_GIVEN, Body, Query, Headers, 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
+
+__all__ = ["MgetResource", "AsyncMgetResource"]
+
+
+class MgetResource(SyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> MgetResourceWithRawResponse:
+        """
+        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/hubmapconsortium/search-python-sdk#accessing-raw-response-data-eg-headers
+        """
+        return MgetResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> MgetResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/hubmapconsortium/search-python-sdk#with_streaming_response
+        """
+        return MgetResourceWithStreamingResponse(self)
+
+    def retrieve_multiple(
+        self,
+        *,
+        body: object,
+        # 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:
+        """
+        To retrieve multiple documents by their IDs, the POST method must provide 1) a
+        request body containing an array of document IDs in the \\__mget format, 2) a
+        bearer token in the Authorization header supplied by HuBMAP. Results are limited
+        to those authorized by the bearer token. Uses the <strong>entities</strong>
+        index by default
+
+        Args:
+          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(
+            "/mget",
+            body=maybe_transform(body, mget_retrieve_multiple_params.MgetRetrieveMultipleParams),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=object,
+        )
+
+    def retrieve_multiple_by_index(
+        self,
+        index_name: str,
+        *,
+        body: object,
+        # 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:
+        """
+        To retrieve multiple documents by their IDs, the POST method must provide 1) a
+        request body containing an array of document IDs in the \\__mget format, 2) a
+        bearer token in the Authorization header supplied by HuBMAP. Results are limited
+        to those authorized by the bearer token. Uses the <strong>entities</strong>
+        index by default
+
+        Args:
+          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 index_name:
+            raise ValueError(f"Expected a non-empty value for `index_name` but received {index_name!r}")
+        return self._post(
+            f"/{index_name}/mget",
+            body=maybe_transform(body, mget_retrieve_multiple_by_index_params.MgetRetrieveMultipleByIndexParams),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=object,
+        )
+
+
+class AsyncMgetResource(AsyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> AsyncMgetResourceWithRawResponse:
+        """
+        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/hubmapconsortium/search-python-sdk#accessing-raw-response-data-eg-headers
+        """
+        return AsyncMgetResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> AsyncMgetResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/hubmapconsortium/search-python-sdk#with_streaming_response
+        """
+        return AsyncMgetResourceWithStreamingResponse(self)
+
+    async def retrieve_multiple(
+        self,
+        *,
+        body: object,
+        # 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:
+        """
+        To retrieve multiple documents by their IDs, the POST method must provide 1) a
+        request body containing an array of document IDs in the \\__mget format, 2) a
+        bearer token in the Authorization header supplied by HuBMAP. Results are limited
+        to those authorized by the bearer token. Uses the <strong>entities</strong>
+        index by default
+
+        Args:
+          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(
+            "/mget",
+            body=await async_maybe_transform(body, mget_retrieve_multiple_params.MgetRetrieveMultipleParams),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=object,
+        )
+
+    async def retrieve_multiple_by_index(
+        self,
+        index_name: str,
+        *,
+        body: object,
+        # 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:
+        """
+        To retrieve multiple documents by their IDs, the POST method must provide 1) a
+        request body containing an array of document IDs in the \\__mget format, 2) a
+        bearer token in the Authorization header supplied by HuBMAP. Results are limited
+        to those authorized by the bearer token. Uses the <strong>entities</strong>
+        index by default
+
+        Args:
+          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 index_name:
+            raise ValueError(f"Expected a non-empty value for `index_name` but received {index_name!r}")
+        return await self._post(
+            f"/{index_name}/mget",
+            body=await async_maybe_transform(
+                body, mget_retrieve_multiple_by_index_params.MgetRetrieveMultipleByIndexParams
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=object,
+        )
+
+
+class MgetResourceWithRawResponse:
+    def __init__(self, mget: MgetResource) -> None:
+        self._mget = mget
+
+        self.retrieve_multiple = to_raw_response_wrapper(
+            mget.retrieve_multiple,
+        )
+        self.retrieve_multiple_by_index = to_raw_response_wrapper(
+            mget.retrieve_multiple_by_index,
+        )
+
+
+class AsyncMgetResourceWithRawResponse:
+    def __init__(self, mget: AsyncMgetResource) -> None:
+        self._mget = mget
+
+        self.retrieve_multiple = async_to_raw_response_wrapper(
+            mget.retrieve_multiple,
+        )
+        self.retrieve_multiple_by_index = async_to_raw_response_wrapper(
+            mget.retrieve_multiple_by_index,
+        )
+
+
+class MgetResourceWithStreamingResponse:
+    def __init__(self, mget: MgetResource) -> None:
+        self._mget = mget
+
+        self.retrieve_multiple = to_streamed_response_wrapper(
+            mget.retrieve_multiple,
+        )
+        self.retrieve_multiple_by_index = to_streamed_response_wrapper(
+            mget.retrieve_multiple_by_index,
+        )
+
+
+class AsyncMgetResourceWithStreamingResponse:
+    def __init__(self, mget: AsyncMgetResource) -> None:
+        self._mget = mget
+
+        self.retrieve_multiple = async_to_streamed_response_wrapper(
+            mget.retrieve_multiple,
+        )
+        self.retrieve_multiple_by_index = async_to_streamed_response_wrapper(
+            mget.retrieve_multiple_by_index,
+        )

hubmap_search_sdk/resources/param_search.py

@@ -0,0 +1,197 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+import httpx
+
+from ..types import param_search_execute_params
+from .._types import NOT_GIVEN, Body, Query, Headers, 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
+
+__all__ = ["ParamSearchResource", "AsyncParamSearchResource"]
+
+
+class ParamSearchResource(SyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> ParamSearchResourceWithRawResponse:
+        """
+        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/hubmapconsortium/search-python-sdk#accessing-raw-response-data-eg-headers
+        """
+        return ParamSearchResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> ParamSearchResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/hubmapconsortium/search-python-sdk#with_streaming_response
+        """
+        return ParamSearchResourceWithStreamingResponse(self)
+
+    def execute(
+        self,
+        entity_type: str,
+        *,
+        produce_clt_manifest: 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:
+        """
+        Searches datasets based on the given parameter entity-type ('donor', 'dataset',
+        'sample', etc). GET method must provide a bearer token in the Authorization
+        header supplied by HuBMAP. Results are limited to those authorized by the bearer
+        token. For more detailed information on using this endpoint see
+        [Detailed Param Search Docs](https://docs.hubmapconsortium.org/param-search)
+
+        Args:
+          produce_clt_manifest: An optional parameter that, when set to "true", will make the endpoint return a
+              text representation of a manifest file that corresponds with the datasets
+              queried rather than the original response
+
+          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 entity_type:
+            raise ValueError(f"Expected a non-empty value for `entity_type` but received {entity_type!r}")
+        return self._get(
+            f"/param-search/{entity_type}",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {"produce_clt_manifest": produce_clt_manifest}, param_search_execute_params.ParamSearchExecuteParams
+                ),
+            ),
+            cast_to=object,
+        )
+
+
+class AsyncParamSearchResource(AsyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> AsyncParamSearchResourceWithRawResponse:
+        """
+        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/hubmapconsortium/search-python-sdk#accessing-raw-response-data-eg-headers
+        """
+        return AsyncParamSearchResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> AsyncParamSearchResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/hubmapconsortium/search-python-sdk#with_streaming_response
+        """
+        return AsyncParamSearchResourceWithStreamingResponse(self)
+
+    async def execute(
+        self,
+        entity_type: str,
+        *,
+        produce_clt_manifest: 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:
+        """
+        Searches datasets based on the given parameter entity-type ('donor', 'dataset',
+        'sample', etc). GET method must provide a bearer token in the Authorization
+        header supplied by HuBMAP. Results are limited to those authorized by the bearer
+        token. For more detailed information on using this endpoint see
+        [Detailed Param Search Docs](https://docs.hubmapconsortium.org/param-search)
+
+        Args:
+          produce_clt_manifest: An optional parameter that, when set to "true", will make the endpoint return a
+              text representation of a manifest file that corresponds with the datasets
+              queried rather than the original response
+
+          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 entity_type:
+            raise ValueError(f"Expected a non-empty value for `entity_type` but received {entity_type!r}")
+        return await self._get(
+            f"/param-search/{entity_type}",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=await async_maybe_transform(
+                    {"produce_clt_manifest": produce_clt_manifest}, param_search_execute_params.ParamSearchExecuteParams
+                ),
+            ),
+            cast_to=object,
+        )
+
+
+class ParamSearchResourceWithRawResponse:
+    def __init__(self, param_search: ParamSearchResource) -> None:
+        self._param_search = param_search
+
+        self.execute = to_raw_response_wrapper(
+            param_search.execute,
+        )
+
+
+class AsyncParamSearchResourceWithRawResponse:
+    def __init__(self, param_search: AsyncParamSearchResource) -> None:
+        self._param_search = param_search
+
+        self.execute = async_to_raw_response_wrapper(
+            param_search.execute,
+        )
+
+
+class ParamSearchResourceWithStreamingResponse:
+    def __init__(self, param_search: ParamSearchResource) -> None:
+        self._param_search = param_search
+
+        self.execute = to_streamed_response_wrapper(
+            param_search.execute,
+        )
+
+
+class AsyncParamSearchResourceWithStreamingResponse:
+    def __init__(self, param_search: AsyncParamSearchResource) -> None:
+        self._param_search = param_search
+
+        self.execute = async_to_streamed_response_wrapper(
+            param_search.execute,
+        )

hubmap_search_sdk/resources/reindex.py

@@ -0,0 +1,164 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+import httpx
+
+from .._types import NOT_GIVEN, Body, Query, Headers, NoneType, NotGiven
+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
+
+__all__ = ["ReindexResource", "AsyncReindexResource"]
+
+
+class ReindexResource(SyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> ReindexResourceWithRawResponse:
+        """
+        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/hubmapconsortium/search-python-sdk#accessing-raw-response-data-eg-headers
+        """
+        return ReindexResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> ReindexResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/hubmapconsortium/search-python-sdk#with_streaming_response
+        """
+        return ReindexResourceWithStreamingResponse(self)
+
+    def update(
+        self,
+        identifier: 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:
+        """
+        Reindex for a given UUID of dataset
+
+        Args:
+          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 identifier:
+            raise ValueError(f"Expected a non-empty value for `identifier` but received {identifier!r}")
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        return self._put(
+            f"/reindex/{identifier}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=NoneType,
+        )
+
+
+class AsyncReindexResource(AsyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> AsyncReindexResourceWithRawResponse:
+        """
+        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/hubmapconsortium/search-python-sdk#accessing-raw-response-data-eg-headers
+        """
+        return AsyncReindexResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> AsyncReindexResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/hubmapconsortium/search-python-sdk#with_streaming_response
+        """
+        return AsyncReindexResourceWithStreamingResponse(self)
+
+    async def update(
+        self,
+        identifier: 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:
+        """
+        Reindex for a given UUID of dataset
+
+        Args:
+          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 identifier:
+            raise ValueError(f"Expected a non-empty value for `identifier` but received {identifier!r}")
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        return await self._put(
+            f"/reindex/{identifier}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=NoneType,
+        )
+
+
+class ReindexResourceWithRawResponse:
+    def __init__(self, reindex: ReindexResource) -> None:
+        self._reindex = reindex
+
+        self.update = to_raw_response_wrapper(
+            reindex.update,
+        )
+
+
+class AsyncReindexResourceWithRawResponse:
+    def __init__(self, reindex: AsyncReindexResource) -> None:
+        self._reindex = reindex
+
+        self.update = async_to_raw_response_wrapper(
+            reindex.update,
+        )
+
+
+class ReindexResourceWithStreamingResponse:
+    def __init__(self, reindex: ReindexResource) -> None:
+        self._reindex = reindex
+
+        self.update = to_streamed_response_wrapper(
+            reindex.update,
+        )
+
+
+class AsyncReindexResourceWithStreamingResponse:
+    def __init__(self, reindex: AsyncReindexResource) -> None:
+        self._reindex = reindex
+
+        self.update = async_to_streamed_response_wrapper(
+            reindex.update,
+        )