anchorbrowser 0.1.0__py3-none-any.whl

anchorbrowser/resources/profiles.py

@@ -0,0 +1,553 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal
+
+import httpx
+
+from ..types import profile_create_params, profile_update_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.profile_list_response import ProfileListResponse
+from ..types.shared.success_response import SuccessResponse
+from ..types.profile_retrieve_response import ProfileRetrieveResponse
+
+__all__ = ["ProfilesResource", "AsyncProfilesResource"]
+
+
+class ProfilesResource(SyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> ProfilesResourceWithRawResponse:
+        """
+        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/anchorbrowser/AnchorBrowser-SDK-Python#accessing-raw-response-data-eg-headers
+        """
+        return ProfilesResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> ProfilesResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/anchorbrowser/AnchorBrowser-SDK-Python#with_streaming_response
+        """
+        return ProfilesResourceWithStreamingResponse(self)
+
+    def create(
+        self,
+        *,
+        name: str,
+        description: str | NotGiven = NOT_GIVEN,
+        session_id: str | NotGiven = NOT_GIVEN,
+        source: Literal["session"] | NotGiven = NOT_GIVEN,
+        store_cache: 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,
+    ) -> SuccessResponse:
+        """Creates a new profile from a browser session.
+
+        A Profile stores cookies, local
+        storage, and cache.
+
+        Args:
+          name: The name of the profile.
+
+          description: A description of the profile.
+
+          session_id: The browser session ID is required if the source is set to `session`. The
+              browser session must be running, and the profile will be stored once the browser
+              session terminates.
+
+          source: The source of the profile data. currently only `session` is supported.
+
+          store_cache: Indicates whether the browser session cache should be saved when the browser
+              session ends. Defaults to `false`.
+
+          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(
+            "/v1/profiles",
+            body=maybe_transform(
+                {
+                    "name": name,
+                    "description": description,
+                    "session_id": session_id,
+                    "source": source,
+                    "store_cache": store_cache,
+                },
+                profile_create_params.ProfileCreateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=SuccessResponse,
+        )
+
+    def retrieve(
+        self,
+        name: 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,
+    ) -> ProfileRetrieveResponse:
+        """
+        Retrieves details of a specific profile by its name.
+
+        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 name:
+            raise ValueError(f"Expected a non-empty value for `name` but received {name!r}")
+        return self._get(
+            f"/v1/profiles/{name}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=ProfileRetrieveResponse,
+        )
+
+    def update(
+        self,
+        name: str,
+        *,
+        description: str | NotGiven = NOT_GIVEN,
+        session_id: str | NotGiven = NOT_GIVEN,
+        source: Literal["session"] | NotGiven = NOT_GIVEN,
+        store_cache: 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,
+    ) -> SuccessResponse:
+        """
+        Updates the description or data of an existing profile using a browser session.
+
+        Args:
+          description: The new description for the profile.
+
+          session_id: The browser session ID is required if the source is set to `session`. The
+              browser session must belong to the user and be active.
+
+          source: The source of the profile data. Currently, only `session` is supported.
+
+          store_cache: Indicates whether the browser session cache should be saved when the browser
+              session ends. Defaults to `false`.
+
+          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 name:
+            raise ValueError(f"Expected a non-empty value for `name` but received {name!r}")
+        return self._put(
+            f"/v1/profiles/{name}",
+            body=maybe_transform(
+                {
+                    "description": description,
+                    "session_id": session_id,
+                    "source": source,
+                    "store_cache": store_cache,
+                },
+                profile_update_params.ProfileUpdateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=SuccessResponse,
+        )
+
+    def list(
+        self,
+        *,
+        # 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,
+    ) -> ProfileListResponse:
+        """Fetches all stored profiles."""
+        return self._get(
+            "/v1/profiles",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=ProfileListResponse,
+        )
+
+    def delete(
+        self,
+        name: 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,
+    ) -> SuccessResponse:
+        """
+        Deletes an existing profile by its name.
+
+        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 name:
+            raise ValueError(f"Expected a non-empty value for `name` but received {name!r}")
+        return self._delete(
+            f"/v1/profiles/{name}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=SuccessResponse,
+        )
+
+
+class AsyncProfilesResource(AsyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> AsyncProfilesResourceWithRawResponse:
+        """
+        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/anchorbrowser/AnchorBrowser-SDK-Python#accessing-raw-response-data-eg-headers
+        """
+        return AsyncProfilesResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> AsyncProfilesResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/anchorbrowser/AnchorBrowser-SDK-Python#with_streaming_response
+        """
+        return AsyncProfilesResourceWithStreamingResponse(self)
+
+    async def create(
+        self,
+        *,
+        name: str,
+        description: str | NotGiven = NOT_GIVEN,
+        session_id: str | NotGiven = NOT_GIVEN,
+        source: Literal["session"] | NotGiven = NOT_GIVEN,
+        store_cache: 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,
+    ) -> SuccessResponse:
+        """Creates a new profile from a browser session.
+
+        A Profile stores cookies, local
+        storage, and cache.
+
+        Args:
+          name: The name of the profile.
+
+          description: A description of the profile.
+
+          session_id: The browser session ID is required if the source is set to `session`. The
+              browser session must be running, and the profile will be stored once the browser
+              session terminates.
+
+          source: The source of the profile data. currently only `session` is supported.
+
+          store_cache: Indicates whether the browser session cache should be saved when the browser
+              session ends. Defaults to `false`.
+
+          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(
+            "/v1/profiles",
+            body=await async_maybe_transform(
+                {
+                    "name": name,
+                    "description": description,
+                    "session_id": session_id,
+                    "source": source,
+                    "store_cache": store_cache,
+                },
+                profile_create_params.ProfileCreateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=SuccessResponse,
+        )
+
+    async def retrieve(
+        self,
+        name: 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,
+    ) -> ProfileRetrieveResponse:
+        """
+        Retrieves details of a specific profile by its name.
+
+        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 name:
+            raise ValueError(f"Expected a non-empty value for `name` but received {name!r}")
+        return await self._get(
+            f"/v1/profiles/{name}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=ProfileRetrieveResponse,
+        )
+
+    async def update(
+        self,
+        name: str,
+        *,
+        description: str | NotGiven = NOT_GIVEN,
+        session_id: str | NotGiven = NOT_GIVEN,
+        source: Literal["session"] | NotGiven = NOT_GIVEN,
+        store_cache: 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,
+    ) -> SuccessResponse:
+        """
+        Updates the description or data of an existing profile using a browser session.
+
+        Args:
+          description: The new description for the profile.
+
+          session_id: The browser session ID is required if the source is set to `session`. The
+              browser session must belong to the user and be active.
+
+          source: The source of the profile data. Currently, only `session` is supported.
+
+          store_cache: Indicates whether the browser session cache should be saved when the browser
+              session ends. Defaults to `false`.
+
+          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 name:
+            raise ValueError(f"Expected a non-empty value for `name` but received {name!r}")
+        return await self._put(
+            f"/v1/profiles/{name}",
+            body=await async_maybe_transform(
+                {
+                    "description": description,
+                    "session_id": session_id,
+                    "source": source,
+                    "store_cache": store_cache,
+                },
+                profile_update_params.ProfileUpdateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=SuccessResponse,
+        )
+
+    async def list(
+        self,
+        *,
+        # 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,
+    ) -> ProfileListResponse:
+        """Fetches all stored profiles."""
+        return await self._get(
+            "/v1/profiles",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=ProfileListResponse,
+        )
+
+    async def delete(
+        self,
+        name: 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,
+    ) -> SuccessResponse:
+        """
+        Deletes an existing profile by its name.
+
+        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 name:
+            raise ValueError(f"Expected a non-empty value for `name` but received {name!r}")
+        return await self._delete(
+            f"/v1/profiles/{name}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=SuccessResponse,
+        )
+
+
+class ProfilesResourceWithRawResponse:
+    def __init__(self, profiles: ProfilesResource) -> None:
+        self._profiles = profiles
+
+        self.create = to_raw_response_wrapper(
+            profiles.create,
+        )
+        self.retrieve = to_raw_response_wrapper(
+            profiles.retrieve,
+        )
+        self.update = to_raw_response_wrapper(
+            profiles.update,
+        )
+        self.list = to_raw_response_wrapper(
+            profiles.list,
+        )
+        self.delete = to_raw_response_wrapper(
+            profiles.delete,
+        )
+
+
+class AsyncProfilesResourceWithRawResponse:
+    def __init__(self, profiles: AsyncProfilesResource) -> None:
+        self._profiles = profiles
+
+        self.create = async_to_raw_response_wrapper(
+            profiles.create,
+        )
+        self.retrieve = async_to_raw_response_wrapper(
+            profiles.retrieve,
+        )
+        self.update = async_to_raw_response_wrapper(
+            profiles.update,
+        )
+        self.list = async_to_raw_response_wrapper(
+            profiles.list,
+        )
+        self.delete = async_to_raw_response_wrapper(
+            profiles.delete,
+        )
+
+
+class ProfilesResourceWithStreamingResponse:
+    def __init__(self, profiles: ProfilesResource) -> None:
+        self._profiles = profiles
+
+        self.create = to_streamed_response_wrapper(
+            profiles.create,
+        )
+        self.retrieve = to_streamed_response_wrapper(
+            profiles.retrieve,
+        )
+        self.update = to_streamed_response_wrapper(
+            profiles.update,
+        )
+        self.list = to_streamed_response_wrapper(
+            profiles.list,
+        )
+        self.delete = to_streamed_response_wrapper(
+            profiles.delete,
+        )
+
+
+class AsyncProfilesResourceWithStreamingResponse:
+    def __init__(self, profiles: AsyncProfilesResource) -> None:
+        self._profiles = profiles
+
+        self.create = async_to_streamed_response_wrapper(
+            profiles.create,
+        )
+        self.retrieve = async_to_streamed_response_wrapper(
+            profiles.retrieve,
+        )
+        self.update = async_to_streamed_response_wrapper(
+            profiles.update,
+        )
+        self.list = async_to_streamed_response_wrapper(
+            profiles.list,
+        )
+        self.delete = async_to_streamed_response_wrapper(
+            profiles.delete,
+        )

anchorbrowser/resources/sessions/__init__.py

@@ -0,0 +1,89 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from .all import (
+    AllResource,
+    AsyncAllResource,
+    AllResourceWithRawResponse,
+    AsyncAllResourceWithRawResponse,
+    AllResourceWithStreamingResponse,
+    AsyncAllResourceWithStreamingResponse,
+)
+from .mouse import (
+    MouseResource,
+    AsyncMouseResource,
+    MouseResourceWithRawResponse,
+    AsyncMouseResourceWithRawResponse,
+    MouseResourceWithStreamingResponse,
+    AsyncMouseResourceWithStreamingResponse,
+)
+from .keyboard import (
+    KeyboardResource,
+    AsyncKeyboardResource,
+    KeyboardResourceWithRawResponse,
+    AsyncKeyboardResourceWithRawResponse,
+    KeyboardResourceWithStreamingResponse,
+    AsyncKeyboardResourceWithStreamingResponse,
+)
+from .sessions import (
+    SessionsResource,
+    AsyncSessionsResource,
+    SessionsResourceWithRawResponse,
+    AsyncSessionsResourceWithRawResponse,
+    SessionsResourceWithStreamingResponse,
+    AsyncSessionsResourceWithStreamingResponse,
+)
+from .clipboard import (
+    ClipboardResource,
+    AsyncClipboardResource,
+    ClipboardResourceWithRawResponse,
+    AsyncClipboardResourceWithRawResponse,
+    ClipboardResourceWithStreamingResponse,
+    AsyncClipboardResourceWithStreamingResponse,
+)
+from .recordings import (
+    RecordingsResource,
+    AsyncRecordingsResource,
+    RecordingsResourceWithRawResponse,
+    AsyncRecordingsResourceWithRawResponse,
+    RecordingsResourceWithStreamingResponse,
+    AsyncRecordingsResourceWithStreamingResponse,
+)
+
+__all__ = [
+    "AllResource",
+    "AsyncAllResource",
+    "AllResourceWithRawResponse",
+    "AsyncAllResourceWithRawResponse",
+    "AllResourceWithStreamingResponse",
+    "AsyncAllResourceWithStreamingResponse",
+    "RecordingsResource",
+    "AsyncRecordingsResource",
+    "RecordingsResourceWithRawResponse",
+    "AsyncRecordingsResourceWithRawResponse",
+    "RecordingsResourceWithStreamingResponse",
+    "AsyncRecordingsResourceWithStreamingResponse",
+    "MouseResource",
+    "AsyncMouseResource",
+    "MouseResourceWithRawResponse",
+    "AsyncMouseResourceWithRawResponse",
+    "MouseResourceWithStreamingResponse",
+    "AsyncMouseResourceWithStreamingResponse",
+    "KeyboardResource",
+    "AsyncKeyboardResource",
+    "KeyboardResourceWithRawResponse",
+    "AsyncKeyboardResourceWithRawResponse",
+    "KeyboardResourceWithStreamingResponse",
+    "AsyncKeyboardResourceWithStreamingResponse",
+    "ClipboardResource",
+    "AsyncClipboardResource",
+    "ClipboardResourceWithRawResponse",
+    "AsyncClipboardResourceWithRawResponse",
+    "ClipboardResourceWithStreamingResponse",
+    "AsyncClipboardResourceWithStreamingResponse",
+    "SessionsResource",
+    "AsyncSessionsResource",
+    "SessionsResourceWithRawResponse",
+    "AsyncSessionsResourceWithRawResponse",
+    "SessionsResourceWithStreamingResponse",
+    "AsyncSessionsResourceWithStreamingResponse",
+]