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

hubmap_search_sdk/resources/update.py

@@ -0,0 +1,367 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+import httpx
+
+from ..types import (
+    update_update_document_params,
+    update_update_document_at_index_params,
+    update_update_document_with_scope_params,
+)
+from .._types import NOT_GIVEN, Body, Query, Headers, NoneType, 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__ = ["UpdateResource", "AsyncUpdateResource"]
+
+
+class UpdateResource(SyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> UpdateResourceWithRawResponse:
+        """
+        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 UpdateResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> UpdateResourceWithStreamingResponse:
+        """
+        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 UpdateResourceWithStreamingResponse(self)
+
+    def update_document(
+        self,
+        uuid: 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,
+    ) -> None:
+        """
+        Update a specific document with the passed in UUID
+
+        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 uuid:
+            raise ValueError(f"Expected a non-empty value for `uuid` but received {uuid!r}")
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        return self._put(
+            f"/update/{uuid}",
+            body=maybe_transform(body, update_update_document_params.UpdateUpdateDocumentParams),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=NoneType,
+        )
+
+    def update_document_at_index(
+        self,
+        index: str,
+        *,
+        uuid: 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,
+    ) -> None:
+        """
+        Update a specific document with the passed in UUID and index
+
+        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 uuid:
+            raise ValueError(f"Expected a non-empty value for `uuid` but received {uuid!r}")
+        if not index:
+            raise ValueError(f"Expected a non-empty value for `index` but received {index!r}")
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        return self._put(
+            f"/update/{uuid}/{index}",
+            body=maybe_transform(body, update_update_document_at_index_params.UpdateUpdateDocumentAtIndexParams),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=NoneType,
+        )
+
+    def update_document_with_scope(
+        self,
+        scope: str,
+        *,
+        uuid: str,
+        index: 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,
+    ) -> None:
+        """
+        Update a specific document with the passed in UUID, Index, and Scope
+
+        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 uuid:
+            raise ValueError(f"Expected a non-empty value for `uuid` but received {uuid!r}")
+        if not index:
+            raise ValueError(f"Expected a non-empty value for `index` but received {index!r}")
+        if not scope:
+            raise ValueError(f"Expected a non-empty value for `scope` but received {scope!r}")
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        return self._put(
+            f"/update/{uuid}/{index}/{scope}",
+            body=maybe_transform(body, update_update_document_with_scope_params.UpdateUpdateDocumentWithScopeParams),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=NoneType,
+        )
+
+
+class AsyncUpdateResource(AsyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> AsyncUpdateResourceWithRawResponse:
+        """
+        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 AsyncUpdateResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> AsyncUpdateResourceWithStreamingResponse:
+        """
+        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 AsyncUpdateResourceWithStreamingResponse(self)
+
+    async def update_document(
+        self,
+        uuid: 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,
+    ) -> None:
+        """
+        Update a specific document with the passed in UUID
+
+        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 uuid:
+            raise ValueError(f"Expected a non-empty value for `uuid` but received {uuid!r}")
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        return await self._put(
+            f"/update/{uuid}",
+            body=await async_maybe_transform(body, update_update_document_params.UpdateUpdateDocumentParams),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=NoneType,
+        )
+
+    async def update_document_at_index(
+        self,
+        index: str,
+        *,
+        uuid: 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,
+    ) -> None:
+        """
+        Update a specific document with the passed in UUID and index
+
+        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 uuid:
+            raise ValueError(f"Expected a non-empty value for `uuid` but received {uuid!r}")
+        if not index:
+            raise ValueError(f"Expected a non-empty value for `index` but received {index!r}")
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        return await self._put(
+            f"/update/{uuid}/{index}",
+            body=await async_maybe_transform(
+                body, update_update_document_at_index_params.UpdateUpdateDocumentAtIndexParams
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=NoneType,
+        )
+
+    async def update_document_with_scope(
+        self,
+        scope: str,
+        *,
+        uuid: str,
+        index: 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,
+    ) -> None:
+        """
+        Update a specific document with the passed in UUID, Index, and Scope
+
+        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 uuid:
+            raise ValueError(f"Expected a non-empty value for `uuid` but received {uuid!r}")
+        if not index:
+            raise ValueError(f"Expected a non-empty value for `index` but received {index!r}")
+        if not scope:
+            raise ValueError(f"Expected a non-empty value for `scope` but received {scope!r}")
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        return await self._put(
+            f"/update/{uuid}/{index}/{scope}",
+            body=await async_maybe_transform(
+                body, update_update_document_with_scope_params.UpdateUpdateDocumentWithScopeParams
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=NoneType,
+        )
+
+
+class UpdateResourceWithRawResponse:
+    def __init__(self, update: UpdateResource) -> None:
+        self._update = update
+
+        self.update_document = to_raw_response_wrapper(
+            update.update_document,
+        )
+        self.update_document_at_index = to_raw_response_wrapper(
+            update.update_document_at_index,
+        )
+        self.update_document_with_scope = to_raw_response_wrapper(
+            update.update_document_with_scope,
+        )
+
+
+class AsyncUpdateResourceWithRawResponse:
+    def __init__(self, update: AsyncUpdateResource) -> None:
+        self._update = update
+
+        self.update_document = async_to_raw_response_wrapper(
+            update.update_document,
+        )
+        self.update_document_at_index = async_to_raw_response_wrapper(
+            update.update_document_at_index,
+        )
+        self.update_document_with_scope = async_to_raw_response_wrapper(
+            update.update_document_with_scope,
+        )
+
+
+class UpdateResourceWithStreamingResponse:
+    def __init__(self, update: UpdateResource) -> None:
+        self._update = update
+
+        self.update_document = to_streamed_response_wrapper(
+            update.update_document,
+        )
+        self.update_document_at_index = to_streamed_response_wrapper(
+            update.update_document_at_index,
+        )
+        self.update_document_with_scope = to_streamed_response_wrapper(
+            update.update_document_with_scope,
+        )
+
+
+class AsyncUpdateResourceWithStreamingResponse:
+    def __init__(self, update: AsyncUpdateResource) -> None:
+        self._update = update
+
+        self.update_document = async_to_streamed_response_wrapper(
+            update.update_document,
+        )
+        self.update_document_at_index = async_to_streamed_response_wrapper(
+            update.update_document_at_index,
+        )
+        self.update_document_with_scope = async_to_streamed_response_wrapper(
+            update.update_document_with_scope,
+        )

hubmap_search_sdk/types/__init__.py

@@ -0,0 +1,23 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from .index_list_response import IndexListResponse as IndexListResponse
+from .add_create_document_params import AddCreateDocumentParams as AddCreateDocumentParams
+from .param_search_execute_params import ParamSearchExecuteParams as ParamSearchExecuteParams
+from .scroll_search_create_params import ScrollSearchCreateParams as ScrollSearchCreateParams
+from .search_execute_query_params import SearchExecuteQueryParams as SearchExecuteQueryParams
+from .mget_retrieve_multiple_params import MgetRetrieveMultipleParams as MgetRetrieveMultipleParams
+from .update_update_document_params import UpdateUpdateDocumentParams as UpdateUpdateDocumentParams
+from .search_execute_index_query_params import SearchExecuteIndexQueryParams as SearchExecuteIndexQueryParams
+from .add_create_document_with_index_params import AddCreateDocumentWithIndexParams as AddCreateDocumentWithIndexParams
+from .add_update_document_with_scope_params import AddUpdateDocumentWithScopeParams as AddUpdateDocumentWithScopeParams
+from .mget_retrieve_multiple_by_index_params import (
+    MgetRetrieveMultipleByIndexParams as MgetRetrieveMultipleByIndexParams,
+)
+from .update_update_document_at_index_params import (
+    UpdateUpdateDocumentAtIndexParams as UpdateUpdateDocumentAtIndexParams,
+)
+from .update_update_document_with_scope_params import (
+    UpdateUpdateDocumentWithScopeParams as UpdateUpdateDocumentWithScopeParams,
+)

hubmap_search_sdk/types/add_create_document_params.py

@@ -0,0 +1,11 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["AddCreateDocumentParams"]
+
+
+class AddCreateDocumentParams(TypedDict, total=False):
+    body: Required[object]

hubmap_search_sdk/types/add_create_document_with_index_params.py

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["AddCreateDocumentWithIndexParams"]
+
+
+class AddCreateDocumentWithIndexParams(TypedDict, total=False):
+    uuid: Required[str]
+
+    body: Required[object]

hubmap_search_sdk/types/add_update_document_with_scope_params.py

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["AddUpdateDocumentWithScopeParams"]
+
+
+class AddUpdateDocumentWithScopeParams(TypedDict, total=False):
+    uuid: Required[str]
+
+    index: Required[str]
+
+    body: Required[object]

hubmap_search_sdk/types/index_list_response.py

@@ -0,0 +1,11 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from .._models import BaseModel
+
+__all__ = ["IndexListResponse"]
+
+
+class IndexListResponse(BaseModel):
+    indices: Optional[List[str]] = None

hubmap_search_sdk/types/mget_retrieve_multiple_by_index_params.py

@@ -0,0 +1,11 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["MgetRetrieveMultipleByIndexParams"]
+
+
+class MgetRetrieveMultipleByIndexParams(TypedDict, total=False):
+    body: Required[object]

hubmap_search_sdk/types/mget_retrieve_multiple_params.py

@@ -0,0 +1,11 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["MgetRetrieveMultipleParams"]
+
+
+class MgetRetrieveMultipleParams(TypedDict, total=False):
+    body: Required[object]

hubmap_search_sdk/types/param_search_execute_params.py

@@ -0,0 +1,18 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Annotated, TypedDict
+
+from .._utils import PropertyInfo
+
+__all__ = ["ParamSearchExecuteParams"]
+
+
+class ParamSearchExecuteParams(TypedDict, total=False):
+    produce_clt_manifest: Annotated[str, PropertyInfo(alias="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
+    """

hubmap_search_sdk/types/scroll_search_create_params.py

@@ -0,0 +1,11 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["ScrollSearchCreateParams"]
+
+
+class ScrollSearchCreateParams(TypedDict, total=False):
+    body: Required[object]

hubmap_search_sdk/types/search_execute_index_query_params.py

@@ -0,0 +1,20 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, Annotated, TypedDict
+
+from .._utils import PropertyInfo
+
+__all__ = ["SearchExecuteIndexQueryParams"]
+
+
+class SearchExecuteIndexQueryParams(TypedDict, total=False):
+    body: Required[object]
+
+    produce_clt_manifest: Annotated[str, PropertyInfo(alias="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
+    """

hubmap_search_sdk/types/search_execute_query_params.py

@@ -0,0 +1,20 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, Annotated, TypedDict
+
+from .._utils import PropertyInfo
+
+__all__ = ["SearchExecuteQueryParams"]
+
+
+class SearchExecuteQueryParams(TypedDict, total=False):
+    body: Required[object]
+
+    produce_clt_manifest: Annotated[str, PropertyInfo(alias="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
+    """

hubmap_search_sdk/types/update_update_document_at_index_params.py

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["UpdateUpdateDocumentAtIndexParams"]
+
+
+class UpdateUpdateDocumentAtIndexParams(TypedDict, total=False):
+    uuid: Required[str]
+
+    body: Required[object]

hubmap_search_sdk/types/update_update_document_params.py

@@ -0,0 +1,11 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["UpdateUpdateDocumentParams"]
+
+
+class UpdateUpdateDocumentParams(TypedDict, total=False):
+    body: Required[object]

hubmap_search_sdk/types/update_update_document_with_scope_params.py

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["UpdateUpdateDocumentWithScopeParams"]
+
+
+class UpdateUpdateDocumentWithScopeParams(TypedDict, total=False):
+    uuid: Required[str]
+
+    index: Required[str]
+
+    body: Required[object]