environment_classes.py

# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

from __future__ import annotations

from typing import Iterable, Optional

import httpx

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 SyncEnvironmentClassesPage, AsyncEnvironmentClassesPage
from ...._base_client import AsyncPaginator, make_request_options
from ....types.runners.configurations import (
    environment_class_list_params,
    environment_class_create_params,
    environment_class_update_params,
    environment_class_retrieve_params,
)
from ....types.shared.environment_class import EnvironmentClass
from ....types.shared_params.field_value import FieldValue
from ....types.runners.configurations.environment_class_create_response import EnvironmentClassCreateResponse
from ....types.runners.configurations.environment_class_retrieve_response import EnvironmentClassRetrieveResponse

__all__ = ["EnvironmentClassesResource", "AsyncEnvironmentClassesResource"]


class EnvironmentClassesResource(SyncAPIResource):
    @cached_property
    def with_raw_response(self) -> EnvironmentClassesResourceWithRawResponse:
        """
        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/gitpod-io/gitpod-sdk-python#accessing-raw-response-data-eg-headers
        """
        return EnvironmentClassesResourceWithRawResponse(self)

    @cached_property
    def with_streaming_response(self) -> EnvironmentClassesResourceWithStreamingResponse:
        """
        An alternative to `.with_raw_response` that doesn't eagerly read the response body.

        For more information, see https://www.github.com/gitpod-io/gitpod-sdk-python#with_streaming_response
        """
        return EnvironmentClassesResourceWithStreamingResponse(self)

    def create(
        self,
        *,
        configuration: Iterable[FieldValue] | NotGiven = NOT_GIVEN,
        description: str | NotGiven = NOT_GIVEN,
        display_name: str | NotGiven = NOT_GIVEN,
        runner_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,
    ) -> EnvironmentClassCreateResponse:
        """
        CreateEnvironmentClass creates a new environment class on a runner.

        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(
            "/gitpod.v1.RunnerConfigurationService/CreateEnvironmentClass",
            body=maybe_transform(
                {
                    "configuration": configuration,
                    "description": description,
                    "display_name": display_name,
                    "runner_id": runner_id,
                },
                environment_class_create_params.EnvironmentClassCreateParams,
            ),
            options=make_request_options(
                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
            ),
            cast_to=EnvironmentClassCreateResponse,
        )

    def retrieve(
        self,
        *,
        environment_class_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,
    ) -> EnvironmentClassRetrieveResponse:
        """
        GetEnvironmentClass returns a single environment class configured for a runner.

        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(
            "/gitpod.v1.RunnerConfigurationService/GetEnvironmentClass",
            body=maybe_transform(
                {"environment_class_id": environment_class_id},
                environment_class_retrieve_params.EnvironmentClassRetrieveParams,
            ),
            options=make_request_options(
                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
            ),
            cast_to=EnvironmentClassRetrieveResponse,
        )

    def update(
        self,
        *,
        description: Optional[str] | NotGiven = NOT_GIVEN,
        display_name: Optional[str] | NotGiven = NOT_GIVEN,
        enabled: Optional[bool] | NotGiven = NOT_GIVEN,
        environment_class_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:
        """
        UpdateEnvironmentClass updates an existing environment class on a runner.

        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(
            "/gitpod.v1.RunnerConfigurationService/UpdateEnvironmentClass",
            body=maybe_transform(
                {
                    "description": description,
                    "display_name": display_name,
                    "enabled": enabled,
                    "environment_class_id": environment_class_id,
                },
                environment_class_update_params.EnvironmentClassUpdateParams,
            ),
            options=make_request_options(
                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
            ),
            cast_to=object,
        )

    def list(
        self,
        *,
        token: str | NotGiven = NOT_GIVEN,
        page_size: int | NotGiven = NOT_GIVEN,
        filter: environment_class_list_params.Filter | NotGiven = NOT_GIVEN,
        pagination: environment_class_list_params.Pagination | 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,
    ) -> SyncEnvironmentClassesPage[EnvironmentClass]:
        """
        buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE ListEnvironmentClasses returns all
        environment classes configured for a runner.

        Args:
          pagination: pagination contains the pagination options for listing environment classes

          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(
            "/gitpod.v1.RunnerConfigurationService/ListEnvironmentClasses",
            page=SyncEnvironmentClassesPage[EnvironmentClass],
            body=maybe_transform(
                {
                    "filter": filter,
                    "pagination": pagination,
                },
                environment_class_list_params.EnvironmentClassListParams,
            ),
            options=make_request_options(
                extra_headers=extra_headers,
                extra_query=extra_query,
                extra_body=extra_body,
                timeout=timeout,
                query=maybe_transform(
                    {
                        "token": token,
                        "page_size": page_size,
                    },
                    environment_class_list_params.EnvironmentClassListParams,
                ),
            ),
            model=EnvironmentClass,
            method="post",
        )


class AsyncEnvironmentClassesResource(AsyncAPIResource):
    @cached_property
    def with_raw_response(self) -> AsyncEnvironmentClassesResourceWithRawResponse:
        """
        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/gitpod-io/gitpod-sdk-python#accessing-raw-response-data-eg-headers
        """
        return AsyncEnvironmentClassesResourceWithRawResponse(self)

    @cached_property
    def with_streaming_response(self) -> AsyncEnvironmentClassesResourceWithStreamingResponse:
        """
        An alternative to `.with_raw_response` that doesn't eagerly read the response body.

        For more information, see https://www.github.com/gitpod-io/gitpod-sdk-python#with_streaming_response
        """
        return AsyncEnvironmentClassesResourceWithStreamingResponse(self)

    async def create(
        self,
        *,
        configuration: Iterable[FieldValue] | NotGiven = NOT_GIVEN,
        description: str | NotGiven = NOT_GIVEN,
        display_name: str | NotGiven = NOT_GIVEN,
        runner_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,
    ) -> EnvironmentClassCreateResponse:
        """
        CreateEnvironmentClass creates a new environment class on a runner.

        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(
            "/gitpod.v1.RunnerConfigurationService/CreateEnvironmentClass",
            body=await async_maybe_transform(
                {
                    "configuration": configuration,
                    "description": description,
                    "display_name": display_name,
                    "runner_id": runner_id,
                },
                environment_class_create_params.EnvironmentClassCreateParams,
            ),
            options=make_request_options(
                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
            ),
            cast_to=EnvironmentClassCreateResponse,
        )

    async def retrieve(
        self,
        *,
        environment_class_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,
    ) -> EnvironmentClassRetrieveResponse:
        """
        GetEnvironmentClass returns a single environment class configured for a runner.

        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(
            "/gitpod.v1.RunnerConfigurationService/GetEnvironmentClass",
            body=await async_maybe_transform(
                {"environment_class_id": environment_class_id},
                environment_class_retrieve_params.EnvironmentClassRetrieveParams,
            ),
            options=make_request_options(
                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
            ),
            cast_to=EnvironmentClassRetrieveResponse,
        )

    async def update(
        self,
        *,
        description: Optional[str] | NotGiven = NOT_GIVEN,
        display_name: Optional[str] | NotGiven = NOT_GIVEN,
        enabled: Optional[bool] | NotGiven = NOT_GIVEN,
        environment_class_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:
        """
        UpdateEnvironmentClass updates an existing environment class on a runner.

        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(
            "/gitpod.v1.RunnerConfigurationService/UpdateEnvironmentClass",
            body=await async_maybe_transform(
                {
                    "description": description,
                    "display_name": display_name,
                    "enabled": enabled,
                    "environment_class_id": environment_class_id,
                },
                environment_class_update_params.EnvironmentClassUpdateParams,
            ),
            options=make_request_options(
                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
            ),
            cast_to=object,
        )

    def list(
        self,
        *,
        token: str | NotGiven = NOT_GIVEN,
        page_size: int | NotGiven = NOT_GIVEN,
        filter: environment_class_list_params.Filter | NotGiven = NOT_GIVEN,
        pagination: environment_class_list_params.Pagination | 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[EnvironmentClass, AsyncEnvironmentClassesPage[EnvironmentClass]]:
        """
        buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE ListEnvironmentClasses returns all
        environment classes configured for a runner.

        Args:
          pagination: pagination contains the pagination options for listing environment classes

          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(
            "/gitpod.v1.RunnerConfigurationService/ListEnvironmentClasses",
            page=AsyncEnvironmentClassesPage[EnvironmentClass],
            body=maybe_transform(
                {
                    "filter": filter,
                    "pagination": pagination,
                },
                environment_class_list_params.EnvironmentClassListParams,
            ),
            options=make_request_options(
                extra_headers=extra_headers,
                extra_query=extra_query,
                extra_body=extra_body,
                timeout=timeout,
                query=maybe_transform(
                    {
                        "token": token,
                        "page_size": page_size,
                    },
                    environment_class_list_params.EnvironmentClassListParams,
                ),
            ),
            model=EnvironmentClass,
            method="post",
        )


class EnvironmentClassesResourceWithRawResponse:
    def __init__(self, environment_classes: EnvironmentClassesResource) -> None:
        self._environment_classes = environment_classes

        self.create = to_raw_response_wrapper(
            environment_classes.create,
        )
        self.retrieve = to_raw_response_wrapper(
            environment_classes.retrieve,
        )
        self.update = to_raw_response_wrapper(
            environment_classes.update,
        )
        self.list = to_raw_response_wrapper(
            environment_classes.list,
        )


class AsyncEnvironmentClassesResourceWithRawResponse:
    def __init__(self, environment_classes: AsyncEnvironmentClassesResource) -> None:
        self._environment_classes = environment_classes

        self.create = async_to_raw_response_wrapper(
            environment_classes.create,
        )
        self.retrieve = async_to_raw_response_wrapper(
            environment_classes.retrieve,
        )
        self.update = async_to_raw_response_wrapper(
            environment_classes.update,
        )
        self.list = async_to_raw_response_wrapper(
            environment_classes.list,
        )


class EnvironmentClassesResourceWithStreamingResponse:
    def __init__(self, environment_classes: EnvironmentClassesResource) -> None:
        self._environment_classes = environment_classes

        self.create = to_streamed_response_wrapper(
            environment_classes.create,
        )
        self.retrieve = to_streamed_response_wrapper(
            environment_classes.retrieve,
        )
        self.update = to_streamed_response_wrapper(
            environment_classes.update,
        )
        self.list = to_streamed_response_wrapper(
            environment_classes.list,
        )


class AsyncEnvironmentClassesResourceWithStreamingResponse:
    def __init__(self, environment_classes: AsyncEnvironmentClassesResource) -> None:
        self._environment_classes = environment_classes

        self.create = async_to_streamed_response_wrapper(
            environment_classes.create,
        )
        self.retrieve = async_to_streamed_response_wrapper(
            environment_classes.retrieve,
        )
        self.update = async_to_streamed_response_wrapper(
            environment_classes.update,
        )
        self.list = async_to_streamed_response_wrapper(
            environment_classes.list,
        )