raccoonai 0.1.0a1__py3-none-any.whl

raccoonai/resources/fleet.py

@@ -0,0 +1,485 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Optional
+
+import httpx
+
+from ..types import fleet_create_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 .._base_client import make_request_options
+from ..types.fleet_logs_response import FleetLogsResponse
+from ..types.fleet_create_response import FleetCreateResponse
+from ..types.fleet_status_response import FleetStatusResponse
+from ..types.fleet_terminate_response import FleetTerminateResponse
+
+__all__ = ["FleetResource", "AsyncFleetResource"]
+
+
+class FleetResource(SyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> FleetResourceWithRawResponse:
+        """
+        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/flyingraccoonai/raccoonai-python#accessing-raw-response-data-eg-headers
+        """
+        return FleetResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> FleetResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/flyingraccoonai/raccoonai-python#with_streaming_response
+        """
+        return FleetResourceWithStreamingResponse(self)
+
+    def create(
+        self,
+        *,
+        advanced: Optional[fleet_create_params.Advanced] | NotGiven = NOT_GIVEN,
+        app_name: Optional[str] | NotGiven = NOT_GIVEN,
+        browser_type: Optional[str] | NotGiven = NOT_GIVEN,
+        headless: Optional[bool] | NotGiven = NOT_GIVEN,
+        raccoon_passcode: Optional[str] | NotGiven = NOT_GIVEN,
+        session_timeout: Optional[int] | NotGiven = NOT_GIVEN,
+        settings: Optional[fleet_create_params.Settings] | NotGiven = NOT_GIVEN,
+        url: 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,
+    ) -> FleetCreateResponse:
+        """
+        Fleet Websocket Session Create Endpoint
+
+        Args:
+          advanced: Advanced configuration options for the session, such as ad-blocking and CAPTCHA
+              solving.
+
+          app_name: The name of the app for which the session is going to run for, used for
+              streamlining authentication.
+
+          browser_type: The type of browser to use. Supported values include 'chromium', 'firefox', and
+              'webkit'.
+
+          headless: Whether to run the browser in headless mode.
+
+          raccoon_passcode: The raccoon passcode associated with the end user on behalf of which the call is
+              being made if any.
+
+          session_timeout: The timeout for the browser session in seconds.
+
+          settings: Configuration settings for the browser, such as viewport size and User-Agent
+              string.
+
+          url: The entrypoint url for the session.
+
+          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(
+            "/sessions/create",
+            body=maybe_transform(
+                {
+                    "advanced": advanced,
+                    "app_name": app_name,
+                    "browser_type": browser_type,
+                    "headless": headless,
+                    "raccoon_passcode": raccoon_passcode,
+                    "session_timeout": session_timeout,
+                    "settings": settings,
+                    "url": url,
+                },
+                fleet_create_params.FleetCreateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=FleetCreateResponse,
+        )
+
+    def logs(
+        self,
+        session_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,
+    ) -> FleetLogsResponse:
+        """
+        Fleet Session Logs Endpoint
+
+        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 session_id:
+            raise ValueError(f"Expected a non-empty value for `session_id` but received {session_id!r}")
+        return self._get(
+            f"/sessions/{session_id}/logs",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=FleetLogsResponse,
+        )
+
+    def status(
+        self,
+        session_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,
+    ) -> FleetStatusResponse:
+        """
+        Fleet Session Status Endpoint
+
+        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 session_id:
+            raise ValueError(f"Expected a non-empty value for `session_id` but received {session_id!r}")
+        return self._get(
+            f"/sessions/{session_id}/status",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=FleetStatusResponse,
+        )
+
+    def terminate(
+        self,
+        session_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,
+    ) -> FleetTerminateResponse:
+        """
+        Fleet Session Terminate Endpoint
+
+        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 session_id:
+            raise ValueError(f"Expected a non-empty value for `session_id` but received {session_id!r}")
+        return self._delete(
+            f"/sessions/{session_id}/terminate",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=FleetTerminateResponse,
+        )
+
+
+class AsyncFleetResource(AsyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> AsyncFleetResourceWithRawResponse:
+        """
+        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/flyingraccoonai/raccoonai-python#accessing-raw-response-data-eg-headers
+        """
+        return AsyncFleetResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> AsyncFleetResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/flyingraccoonai/raccoonai-python#with_streaming_response
+        """
+        return AsyncFleetResourceWithStreamingResponse(self)
+
+    async def create(
+        self,
+        *,
+        advanced: Optional[fleet_create_params.Advanced] | NotGiven = NOT_GIVEN,
+        app_name: Optional[str] | NotGiven = NOT_GIVEN,
+        browser_type: Optional[str] | NotGiven = NOT_GIVEN,
+        headless: Optional[bool] | NotGiven = NOT_GIVEN,
+        raccoon_passcode: Optional[str] | NotGiven = NOT_GIVEN,
+        session_timeout: Optional[int] | NotGiven = NOT_GIVEN,
+        settings: Optional[fleet_create_params.Settings] | NotGiven = NOT_GIVEN,
+        url: 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,
+    ) -> FleetCreateResponse:
+        """
+        Fleet Websocket Session Create Endpoint
+
+        Args:
+          advanced: Advanced configuration options for the session, such as ad-blocking and CAPTCHA
+              solving.
+
+          app_name: The name of the app for which the session is going to run for, used for
+              streamlining authentication.
+
+          browser_type: The type of browser to use. Supported values include 'chromium', 'firefox', and
+              'webkit'.
+
+          headless: Whether to run the browser in headless mode.
+
+          raccoon_passcode: The raccoon passcode associated with the end user on behalf of which the call is
+              being made if any.
+
+          session_timeout: The timeout for the browser session in seconds.
+
+          settings: Configuration settings for the browser, such as viewport size and User-Agent
+              string.
+
+          url: The entrypoint url for the session.
+
+          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(
+            "/sessions/create",
+            body=await async_maybe_transform(
+                {
+                    "advanced": advanced,
+                    "app_name": app_name,
+                    "browser_type": browser_type,
+                    "headless": headless,
+                    "raccoon_passcode": raccoon_passcode,
+                    "session_timeout": session_timeout,
+                    "settings": settings,
+                    "url": url,
+                },
+                fleet_create_params.FleetCreateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=FleetCreateResponse,
+        )
+
+    async def logs(
+        self,
+        session_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,
+    ) -> FleetLogsResponse:
+        """
+        Fleet Session Logs Endpoint
+
+        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 session_id:
+            raise ValueError(f"Expected a non-empty value for `session_id` but received {session_id!r}")
+        return await self._get(
+            f"/sessions/{session_id}/logs",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=FleetLogsResponse,
+        )
+
+    async def status(
+        self,
+        session_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,
+    ) -> FleetStatusResponse:
+        """
+        Fleet Session Status Endpoint
+
+        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 session_id:
+            raise ValueError(f"Expected a non-empty value for `session_id` but received {session_id!r}")
+        return await self._get(
+            f"/sessions/{session_id}/status",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=FleetStatusResponse,
+        )
+
+    async def terminate(
+        self,
+        session_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,
+    ) -> FleetTerminateResponse:
+        """
+        Fleet Session Terminate Endpoint
+
+        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 session_id:
+            raise ValueError(f"Expected a non-empty value for `session_id` but received {session_id!r}")
+        return await self._delete(
+            f"/sessions/{session_id}/terminate",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=FleetTerminateResponse,
+        )
+
+
+class FleetResourceWithRawResponse:
+    def __init__(self, fleet: FleetResource) -> None:
+        self._fleet = fleet
+
+        self.create = to_raw_response_wrapper(
+            fleet.create,
+        )
+        self.logs = to_raw_response_wrapper(
+            fleet.logs,
+        )
+        self.status = to_raw_response_wrapper(
+            fleet.status,
+        )
+        self.terminate = to_raw_response_wrapper(
+            fleet.terminate,
+        )
+
+
+class AsyncFleetResourceWithRawResponse:
+    def __init__(self, fleet: AsyncFleetResource) -> None:
+        self._fleet = fleet
+
+        self.create = async_to_raw_response_wrapper(
+            fleet.create,
+        )
+        self.logs = async_to_raw_response_wrapper(
+            fleet.logs,
+        )
+        self.status = async_to_raw_response_wrapper(
+            fleet.status,
+        )
+        self.terminate = async_to_raw_response_wrapper(
+            fleet.terminate,
+        )
+
+
+class FleetResourceWithStreamingResponse:
+    def __init__(self, fleet: FleetResource) -> None:
+        self._fleet = fleet
+
+        self.create = to_streamed_response_wrapper(
+            fleet.create,
+        )
+        self.logs = to_streamed_response_wrapper(
+            fleet.logs,
+        )
+        self.status = to_streamed_response_wrapper(
+            fleet.status,
+        )
+        self.terminate = to_streamed_response_wrapper(
+            fleet.terminate,
+        )
+
+
+class AsyncFleetResourceWithStreamingResponse:
+    def __init__(self, fleet: AsyncFleetResource) -> None:
+        self._fleet = fleet
+
+        self.create = async_to_streamed_response_wrapper(
+            fleet.create,
+        )
+        self.logs = async_to_streamed_response_wrapper(
+            fleet.logs,
+        )
+        self.status = async_to_streamed_response_wrapper(
+            fleet.status,
+        )
+        self.terminate = async_to_streamed_response_wrapper(
+            fleet.terminate,
+        )