editors.py

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

from __future__ import annotations

import httpx

from ..types import editor_list_params, editor_retrieve_params, editor_resolve_url_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 SyncEditorsPage, AsyncEditorsPage
from .._base_client import AsyncPaginator, make_request_options
from ..types.editor import Editor
from ..types.editor_retrieve_response import EditorRetrieveResponse
from ..types.editor_resolve_url_response import EditorResolveURLResponse

__all__ = ["EditorsResource", "AsyncEditorsResource"]


class EditorsResource(SyncAPIResource):
    @cached_property
    def with_raw_response(self) -> EditorsResourceWithRawResponse:
        """
        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 EditorsResourceWithRawResponse(self)

    @cached_property
    def with_streaming_response(self) -> EditorsResourceWithStreamingResponse:
        """
        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 EditorsResourceWithStreamingResponse(self)

    def retrieve(
        self,
        *,
        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,
    ) -> EditorRetrieveResponse:
        """
        Gets details about a specific editor.

        Use this method to:

        - View editor information
        - Get editor configuration

        ### Examples

        - Get editor details:

          Retrieves information about a specific editor.

          ```yaml
          id: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
          ```

        Args:
          id: id is the ID of the editor to get

          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.EditorService/GetEditor",
            body=maybe_transform({"id": id}, editor_retrieve_params.EditorRetrieveParams),
            options=make_request_options(
                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
            ),
            cast_to=EditorRetrieveResponse,
        )

    def list(
        self,
        *,
        token: str | NotGiven = NOT_GIVEN,
        page_size: int | NotGiven = NOT_GIVEN,
        pagination: editor_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,
    ) -> SyncEditorsPage[Editor]:
        """
        Lists all available code editors.

        Use this method to:

        - View supported editors
        - Get editor capabilities
        - Browse editor options
        - Check editor availability

        ### Examples

        - List editors:

          Shows all available editors with pagination.

          ```yaml
          pagination:
            pageSize: 20
          ```

        Args:
          pagination: pagination contains the pagination options for listing environments

          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.EditorService/ListEditors",
            page=SyncEditorsPage[Editor],
            body=maybe_transform({"pagination": pagination}, editor_list_params.EditorListParams),
            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,
                    },
                    editor_list_params.EditorListParams,
                ),
            ),
            model=Editor,
            method="post",
        )

    def resolve_url(
        self,
        *,
        editor_id: str,
        environment_id: str,
        organization_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,
    ) -> EditorResolveURLResponse:
        """
        Resolves the URL for accessing an editor in a specific environment.

        Use this method to:

        - Get editor access URLs
        - Launch editors for environments
        - Set up editor connections
        - Configure editor access

        ### Examples

        - Resolve editor URL:

          Gets the URL for accessing an editor in an environment.

          ```yaml
          editorId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
          environmentId: "07e03a28-65a5-4d98-b532-8ea67b188048"
          organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
          ```

        Args:
          editor_id: editorId is the ID of the editor to resolve the URL for

          environment_id: environmentId is the ID of the environment to resolve the URL for

          organization_id: organizationId is the ID of the organization to resolve the URL for

          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.EditorService/ResolveEditorURL",
            body=maybe_transform(
                {
                    "editor_id": editor_id,
                    "environment_id": environment_id,
                    "organization_id": organization_id,
                },
                editor_resolve_url_params.EditorResolveURLParams,
            ),
            options=make_request_options(
                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
            ),
            cast_to=EditorResolveURLResponse,
        )


class AsyncEditorsResource(AsyncAPIResource):
    @cached_property
    def with_raw_response(self) -> AsyncEditorsResourceWithRawResponse:
        """
        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 AsyncEditorsResourceWithRawResponse(self)

    @cached_property
    def with_streaming_response(self) -> AsyncEditorsResourceWithStreamingResponse:
        """
        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 AsyncEditorsResourceWithStreamingResponse(self)

    async def retrieve(
        self,
        *,
        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,
    ) -> EditorRetrieveResponse:
        """
        Gets details about a specific editor.

        Use this method to:

        - View editor information
        - Get editor configuration

        ### Examples

        - Get editor details:

          Retrieves information about a specific editor.

          ```yaml
          id: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
          ```

        Args:
          id: id is the ID of the editor to get

          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.EditorService/GetEditor",
            body=await async_maybe_transform({"id": id}, editor_retrieve_params.EditorRetrieveParams),
            options=make_request_options(
                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
            ),
            cast_to=EditorRetrieveResponse,
        )

    def list(
        self,
        *,
        token: str | NotGiven = NOT_GIVEN,
        page_size: int | NotGiven = NOT_GIVEN,
        pagination: editor_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[Editor, AsyncEditorsPage[Editor]]:
        """
        Lists all available code editors.

        Use this method to:

        - View supported editors
        - Get editor capabilities
        - Browse editor options
        - Check editor availability

        ### Examples

        - List editors:

          Shows all available editors with pagination.

          ```yaml
          pagination:
            pageSize: 20
          ```

        Args:
          pagination: pagination contains the pagination options for listing environments

          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.EditorService/ListEditors",
            page=AsyncEditorsPage[Editor],
            body=maybe_transform({"pagination": pagination}, editor_list_params.EditorListParams),
            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,
                    },
                    editor_list_params.EditorListParams,
                ),
            ),
            model=Editor,
            method="post",
        )

    async def resolve_url(
        self,
        *,
        editor_id: str,
        environment_id: str,
        organization_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,
    ) -> EditorResolveURLResponse:
        """
        Resolves the URL for accessing an editor in a specific environment.

        Use this method to:

        - Get editor access URLs
        - Launch editors for environments
        - Set up editor connections
        - Configure editor access

        ### Examples

        - Resolve editor URL:

          Gets the URL for accessing an editor in an environment.

          ```yaml
          editorId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
          environmentId: "07e03a28-65a5-4d98-b532-8ea67b188048"
          organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
          ```

        Args:
          editor_id: editorId is the ID of the editor to resolve the URL for

          environment_id: environmentId is the ID of the environment to resolve the URL for

          organization_id: organizationId is the ID of the organization to resolve the URL for

          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.EditorService/ResolveEditorURL",
            body=await async_maybe_transform(
                {
                    "editor_id": editor_id,
                    "environment_id": environment_id,
                    "organization_id": organization_id,
                },
                editor_resolve_url_params.EditorResolveURLParams,
            ),
            options=make_request_options(
                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
            ),
            cast_to=EditorResolveURLResponse,
        )


class EditorsResourceWithRawResponse:
    def __init__(self, editors: EditorsResource) -> None:
        self._editors = editors

        self.retrieve = to_raw_response_wrapper(
            editors.retrieve,
        )
        self.list = to_raw_response_wrapper(
            editors.list,
        )
        self.resolve_url = to_raw_response_wrapper(
            editors.resolve_url,
        )


class AsyncEditorsResourceWithRawResponse:
    def __init__(self, editors: AsyncEditorsResource) -> None:
        self._editors = editors

        self.retrieve = async_to_raw_response_wrapper(
            editors.retrieve,
        )
        self.list = async_to_raw_response_wrapper(
            editors.list,
        )
        self.resolve_url = async_to_raw_response_wrapper(
            editors.resolve_url,
        )


class EditorsResourceWithStreamingResponse:
    def __init__(self, editors: EditorsResource) -> None:
        self._editors = editors

        self.retrieve = to_streamed_response_wrapper(
            editors.retrieve,
        )
        self.list = to_streamed_response_wrapper(
            editors.list,
        )
        self.resolve_url = to_streamed_response_wrapper(
            editors.resolve_url,
        )


class AsyncEditorsResourceWithStreamingResponse:
    def __init__(self, editors: AsyncEditorsResource) -> None:
        self._editors = editors

        self.retrieve = async_to_streamed_response_wrapper(
            editors.retrieve,
        )
        self.list = async_to_streamed_response_wrapper(
            editors.list,
        )
        self.resolve_url = async_to_streamed_response_wrapper(
            editors.resolve_url,
        )