scale-gp-beta 0.1.0a4__py3-none-any.whl → 0.1.0a5__py3-none-any.whl

scale_gp_beta/resources/datasets.py

@@ -0,0 +1,569 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Dict, Iterable, Optional
+
+import httpx
+
+from ..types import (
+    dataset_list_params,
+    dataset_create_params,
+    dataset_update_params,
+    dataset_retrieve_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 ..pagination import SyncCursorPage, AsyncCursorPage
+from .._base_client import AsyncPaginator, make_request_options
+from ..types.dataset import Dataset
+from ..types.dataset_delete_response import DatasetDeleteResponse
+
+__all__ = ["DatasetsResource", "AsyncDatasetsResource"]
+
+
+class DatasetsResource(SyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> DatasetsResourceWithRawResponse:
+        """
+        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/scaleapi/sgp-python-beta#accessing-raw-response-data-eg-headers
+        """
+        return DatasetsResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> DatasetsResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/scaleapi/sgp-python-beta#with_streaming_response
+        """
+        return DatasetsResourceWithStreamingResponse(self)
+
+    def create(
+        self,
+        *,
+        data: Iterable[Dict[str, object]],
+        name: str,
+        description: 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,
+    ) -> Dataset:
+        """
+        Create Dataset
+
+        Args:
+          data: Items to be included in the dataset
+
+          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(
+            "/v5/datasets",
+            body=maybe_transform(
+                {
+                    "data": data,
+                    "name": name,
+                    "description": description,
+                },
+                dataset_create_params.DatasetCreateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=Dataset,
+        )
+
+    def retrieve(
+        self,
+        dataset_id: str,
+        *,
+        include_archived: bool | 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,
+    ) -> Dataset:
+        """
+        Get 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 dataset_id:
+            raise ValueError(f"Expected a non-empty value for `dataset_id` but received {dataset_id!r}")
+        return self._get(
+            f"/v5/datasets/{dataset_id}",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {"include_archived": include_archived}, dataset_retrieve_params.DatasetRetrieveParams
+                ),
+            ),
+            cast_to=Dataset,
+        )
+
+    def update(
+        self,
+        dataset_id: str,
+        *,
+        description: str | NotGiven = NOT_GIVEN,
+        name: 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,
+    ) -> Dataset:
+        """
+        Update 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 dataset_id:
+            raise ValueError(f"Expected a non-empty value for `dataset_id` but received {dataset_id!r}")
+        return self._patch(
+            f"/v5/datasets/{dataset_id}",
+            body=maybe_transform(
+                {
+                    "description": description,
+                    "name": name,
+                },
+                dataset_update_params.DatasetUpdateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=Dataset,
+        )
+
+    def list(
+        self,
+        *,
+        ending_before: Optional[str] | NotGiven = NOT_GIVEN,
+        include_archived: bool | NotGiven = NOT_GIVEN,
+        limit: int | NotGiven = NOT_GIVEN,
+        starting_after: Optional[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,
+    ) -> SyncCursorPage[Dataset]:
+        """
+        List Datasets
+
+        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._get_api_list(
+            "/v5/datasets",
+            page=SyncCursorPage[Dataset],
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "ending_before": ending_before,
+                        "include_archived": include_archived,
+                        "limit": limit,
+                        "starting_after": starting_after,
+                    },
+                    dataset_list_params.DatasetListParams,
+                ),
+            ),
+            model=Dataset,
+        )
+
+    def delete(
+        self,
+        dataset_id: 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,
+    ) -> DatasetDeleteResponse:
+        """
+        Delete 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 dataset_id:
+            raise ValueError(f"Expected a non-empty value for `dataset_id` but received {dataset_id!r}")
+        return self._delete(
+            f"/v5/datasets/{dataset_id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=DatasetDeleteResponse,
+        )
+
+
+class AsyncDatasetsResource(AsyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> AsyncDatasetsResourceWithRawResponse:
+        """
+        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/scaleapi/sgp-python-beta#accessing-raw-response-data-eg-headers
+        """
+        return AsyncDatasetsResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> AsyncDatasetsResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/scaleapi/sgp-python-beta#with_streaming_response
+        """
+        return AsyncDatasetsResourceWithStreamingResponse(self)
+
+    async def create(
+        self,
+        *,
+        data: Iterable[Dict[str, object]],
+        name: str,
+        description: 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,
+    ) -> Dataset:
+        """
+        Create Dataset
+
+        Args:
+          data: Items to be included in the dataset
+
+          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(
+            "/v5/datasets",
+            body=await async_maybe_transform(
+                {
+                    "data": data,
+                    "name": name,
+                    "description": description,
+                },
+                dataset_create_params.DatasetCreateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=Dataset,
+        )
+
+    async def retrieve(
+        self,
+        dataset_id: str,
+        *,
+        include_archived: bool | 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,
+    ) -> Dataset:
+        """
+        Get 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 dataset_id:
+            raise ValueError(f"Expected a non-empty value for `dataset_id` but received {dataset_id!r}")
+        return await self._get(
+            f"/v5/datasets/{dataset_id}",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=await async_maybe_transform(
+                    {"include_archived": include_archived}, dataset_retrieve_params.DatasetRetrieveParams
+                ),
+            ),
+            cast_to=Dataset,
+        )
+
+    async def update(
+        self,
+        dataset_id: str,
+        *,
+        description: str | NotGiven = NOT_GIVEN,
+        name: 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,
+    ) -> Dataset:
+        """
+        Update 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 dataset_id:
+            raise ValueError(f"Expected a non-empty value for `dataset_id` but received {dataset_id!r}")
+        return await self._patch(
+            f"/v5/datasets/{dataset_id}",
+            body=await async_maybe_transform(
+                {
+                    "description": description,
+                    "name": name,
+                },
+                dataset_update_params.DatasetUpdateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=Dataset,
+        )
+
+    def list(
+        self,
+        *,
+        ending_before: Optional[str] | NotGiven = NOT_GIVEN,
+        include_archived: bool | NotGiven = NOT_GIVEN,
+        limit: int | NotGiven = NOT_GIVEN,
+        starting_after: Optional[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,
+    ) -> AsyncPaginator[Dataset, AsyncCursorPage[Dataset]]:
+        """
+        List Datasets
+
+        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._get_api_list(
+            "/v5/datasets",
+            page=AsyncCursorPage[Dataset],
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "ending_before": ending_before,
+                        "include_archived": include_archived,
+                        "limit": limit,
+                        "starting_after": starting_after,
+                    },
+                    dataset_list_params.DatasetListParams,
+                ),
+            ),
+            model=Dataset,
+        )
+
+    async def delete(
+        self,
+        dataset_id: 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,
+    ) -> DatasetDeleteResponse:
+        """
+        Delete 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 dataset_id:
+            raise ValueError(f"Expected a non-empty value for `dataset_id` but received {dataset_id!r}")
+        return await self._delete(
+            f"/v5/datasets/{dataset_id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=DatasetDeleteResponse,
+        )
+
+
+class DatasetsResourceWithRawResponse:
+    def __init__(self, datasets: DatasetsResource) -> None:
+        self._datasets = datasets
+
+        self.create = to_raw_response_wrapper(
+            datasets.create,
+        )
+        self.retrieve = to_raw_response_wrapper(
+            datasets.retrieve,
+        )
+        self.update = to_raw_response_wrapper(
+            datasets.update,
+        )
+        self.list = to_raw_response_wrapper(
+            datasets.list,
+        )
+        self.delete = to_raw_response_wrapper(
+            datasets.delete,
+        )
+
+
+class AsyncDatasetsResourceWithRawResponse:
+    def __init__(self, datasets: AsyncDatasetsResource) -> None:
+        self._datasets = datasets
+
+        self.create = async_to_raw_response_wrapper(
+            datasets.create,
+        )
+        self.retrieve = async_to_raw_response_wrapper(
+            datasets.retrieve,
+        )
+        self.update = async_to_raw_response_wrapper(
+            datasets.update,
+        )
+        self.list = async_to_raw_response_wrapper(
+            datasets.list,
+        )
+        self.delete = async_to_raw_response_wrapper(
+            datasets.delete,
+        )
+
+
+class DatasetsResourceWithStreamingResponse:
+    def __init__(self, datasets: DatasetsResource) -> None:
+        self._datasets = datasets
+
+        self.create = to_streamed_response_wrapper(
+            datasets.create,
+        )
+        self.retrieve = to_streamed_response_wrapper(
+            datasets.retrieve,
+        )
+        self.update = to_streamed_response_wrapper(
+            datasets.update,
+        )
+        self.list = to_streamed_response_wrapper(
+            datasets.list,
+        )
+        self.delete = to_streamed_response_wrapper(
+            datasets.delete,
+        )
+
+
+class AsyncDatasetsResourceWithStreamingResponse:
+    def __init__(self, datasets: AsyncDatasetsResource) -> None:
+        self._datasets = datasets
+
+        self.create = async_to_streamed_response_wrapper(
+            datasets.create,
+        )
+        self.retrieve = async_to_streamed_response_wrapper(
+            datasets.retrieve,
+        )
+        self.update = async_to_streamed_response_wrapper(
+            datasets.update,
+        )
+        self.list = async_to_streamed_response_wrapper(
+            datasets.list,
+        )
+        self.delete = async_to_streamed_response_wrapper(
+            datasets.delete,
+        )