errors.py

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

from __future__ import annotations

from typing import Iterable

import httpx

from ..types import error_report_errors_params
from .._types import Body, Omit, Query, Headers, NotGiven, omit, not_given
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
from ..types.error_event_param import ErrorEventParam

__all__ = ["ErrorsResource", "AsyncErrorsResource"]


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

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

    def report_errors(
        self,
        *,
        events: Iterable[ErrorEventParam] | Omit = omit,
        # 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:
        """
        ReportErrors allows clients to report batches of errors that will be sent to
        error reporting systems. The structure is fully compatible with Sentry's event
        payload format.

        Use this method to:

        - Report client-side errors and exceptions
        - Track application crashes and panics
        - Send error context and metadata for debugging

        ### Examples

        - Report a JavaScript error with Sentry-compatible structure: The service
          accepts events with comprehensive error information including stack traces,
          identity context, breadcrumbs, and metadata that align with Sentry's event
          payload format.

        Args:
          events: Error events to be reported (batch) - now using Sentry-compatible structure

          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.ErrorsService/ReportErrors",
            body=maybe_transform({"events": events}, error_report_errors_params.ErrorReportErrorsParams),
            options=make_request_options(
                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
            ),
            cast_to=object,
        )


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

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

    async def report_errors(
        self,
        *,
        events: Iterable[ErrorEventParam] | Omit = omit,
        # 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:
        """
        ReportErrors allows clients to report batches of errors that will be sent to
        error reporting systems. The structure is fully compatible with Sentry's event
        payload format.

        Use this method to:

        - Report client-side errors and exceptions
        - Track application crashes and panics
        - Send error context and metadata for debugging

        ### Examples

        - Report a JavaScript error with Sentry-compatible structure: The service
          accepts events with comprehensive error information including stack traces,
          identity context, breadcrumbs, and metadata that align with Sentry's event
          payload format.

        Args:
          events: Error events to be reported (batch) - now using Sentry-compatible structure

          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.ErrorsService/ReportErrors",
            body=await async_maybe_transform({"events": events}, error_report_errors_params.ErrorReportErrorsParams),
            options=make_request_options(
                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
            ),
            cast_to=object,
        )


class ErrorsResourceWithRawResponse:
    def __init__(self, errors: ErrorsResource) -> None:
        self._errors = errors

        self.report_errors = to_raw_response_wrapper(
            errors.report_errors,
        )


class AsyncErrorsResourceWithRawResponse:
    def __init__(self, errors: AsyncErrorsResource) -> None:
        self._errors = errors

        self.report_errors = async_to_raw_response_wrapper(
            errors.report_errors,
        )


class ErrorsResourceWithStreamingResponse:
    def __init__(self, errors: ErrorsResource) -> None:
        self._errors = errors

        self.report_errors = to_streamed_response_wrapper(
            errors.report_errors,
        )


class AsyncErrorsResourceWithStreamingResponse:
    def __init__(self, errors: AsyncErrorsResource) -> None:
        self._errors = errors

        self.report_errors = async_to_streamed_response_wrapper(
            errors.report_errors,
        )