anchorbrowser 0.1.1__py3-none-any.whl → 0.3.0__py3-none-any.whl

anchorbrowser/resources/task.py

@@ -0,0 +1,465 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Dict
+from typing_extensions import Literal
+
+import httpx
+
+from ..types import task_list_params, task_create_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 ..types.task import run_execute_params
+from .._base_client import make_request_options
+from ..types.task_list_response import TaskListResponse
+from ..types.task_create_response import TaskCreateResponse
+from ..types.task.run_execute_response import RunExecuteResponse
+
+__all__ = ["TaskResource", "AsyncTaskResource"]
+
+
+class TaskResource(SyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> TaskResourceWithRawResponse:
+        """
+        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 TaskResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> TaskResourceWithStreamingResponse:
+        """
+        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 TaskResourceWithStreamingResponse(self)
+
+    def create(
+        self,
+        *,
+        language: Literal["typescript"],
+        name: str,
+        browser_configuration: task_create_params.BrowserConfiguration | Omit = omit,
+        code: str | Omit = omit,
+        description: str | 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,
+    ) -> TaskCreateResponse:
+        """Creates a new task or updates an existing task with the same name.
+
+        Tasks are
+        reusable code snippets that can be executed in browser sessions. Tasks support
+        versioning with draft and published versions.
+
+        Args:
+          language: Programming language for the task
+
+          name: Task name (letters, numbers, hyphens, and underscores only)
+
+          browser_configuration: Browser configuration for task execution
+
+          code: Base64 encoded task code (optional)
+
+          description: Optional description of the task
+
+          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/task",
+            body=maybe_transform(
+                {
+                    "language": language,
+                    "name": name,
+                    "browser_configuration": browser_configuration,
+                    "code": code,
+                    "description": description,
+                },
+                task_create_params.TaskCreateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=TaskCreateResponse,
+        )
+
+    def list(
+        self,
+        *,
+        limit: str | Omit = omit,
+        page: str | 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,
+    ) -> TaskListResponse:
+        """Retrieves a paginated list of all tasks for the authenticated team.
+
+        Tasks are
+        returned with their latest version information and metadata.
+
+        Args:
+          limit: Number of tasks per page
+
+          page: Page number
+
+          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(
+            "/v1/task",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "limit": limit,
+                        "page": page,
+                    },
+                    task_list_params.TaskListParams,
+                ),
+            ),
+            cast_to=TaskListResponse,
+        )
+
+    def run(
+        self,
+        *,
+        task_id: str,
+        inputs: Dict[str, str] | Omit = omit,
+        override_browser_configuration: run_execute_params.OverrideBrowserConfiguration | Omit = omit,
+        session_id: str | Omit = omit,
+        task_session_id: str | Omit = omit,
+        version: str | 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,
+    ) -> RunExecuteResponse:
+        """Executes a task in a browser session.
+
+        The task can be run with a specific
+        version or the latest version. Optionally, you can provide an existing session
+        ID or let the system create a new one.
+
+        Args:
+          task_id: Task identifier
+
+          inputs: Environment variables for task execution (keys must start with ANCHOR\\__)
+
+          override_browser_configuration: Override browser configuration for this execution
+
+          session_id: Optional existing session ID to use
+
+          task_session_id: Optional task-specific session ID
+
+          version: Version to run (draft, latest, or version number)
+
+          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/task/run",
+            body=maybe_transform(
+                {
+                    "task_id": task_id,
+                    "inputs": inputs,
+                    "override_browser_configuration": override_browser_configuration,
+                    "session_id": session_id,
+                    "task_session_id": task_session_id,
+                    "version": version,
+                },
+                run_execute_params.RunExecuteParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=RunExecuteResponse,
+        )
+
+
+class AsyncTaskResource(AsyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> AsyncTaskResourceWithRawResponse:
+        """
+        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 AsyncTaskResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> AsyncTaskResourceWithStreamingResponse:
+        """
+        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 AsyncTaskResourceWithStreamingResponse(self)
+
+    async def create(
+        self,
+        *,
+        language: Literal["typescript"],
+        name: str,
+        browser_configuration: task_create_params.BrowserConfiguration | Omit = omit,
+        code: str | Omit = omit,
+        description: str | 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,
+    ) -> TaskCreateResponse:
+        """Creates a new task or updates an existing task with the same name.
+
+        Tasks are
+        reusable code snippets that can be executed in browser sessions. Tasks support
+        versioning with draft and published versions.
+
+        Args:
+          language: Programming language for the task
+
+          name: Task name (letters, numbers, hyphens, and underscores only)
+
+          browser_configuration: Browser configuration for task execution
+
+          code: Base64 encoded task code (optional)
+
+          description: Optional description of the task
+
+          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/task",
+            body=await async_maybe_transform(
+                {
+                    "language": language,
+                    "name": name,
+                    "browser_configuration": browser_configuration,
+                    "code": code,
+                    "description": description,
+                },
+                task_create_params.TaskCreateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=TaskCreateResponse,
+        )
+
+    async def list(
+        self,
+        *,
+        limit: str | Omit = omit,
+        page: str | 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,
+    ) -> TaskListResponse:
+        """Retrieves a paginated list of all tasks for the authenticated team.
+
+        Tasks are
+        returned with their latest version information and metadata.
+
+        Args:
+          limit: Number of tasks per page
+
+          page: Page number
+
+          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._get(
+            "/v1/task",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=await async_maybe_transform(
+                    {
+                        "limit": limit,
+                        "page": page,
+                    },
+                    task_list_params.TaskListParams,
+                ),
+            ),
+            cast_to=TaskListResponse,
+        )
+
+    async def run(
+        self,
+        *,
+        task_id: str,
+        inputs: Dict[str, str] | Omit = omit,
+        override_browser_configuration: run_execute_params.OverrideBrowserConfiguration | Omit = omit,
+        session_id: str | Omit = omit,
+        task_session_id: str | Omit = omit,
+        version: str | 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,
+    ) -> RunExecuteResponse:
+        """Executes a task in a browser session.
+
+        The task can be run with a specific
+        version or the latest version. Optionally, you can provide an existing session
+        ID or let the system create a new one.
+
+        Args:
+          task_id: Task identifier
+
+          inputs: Environment variables for task execution (keys must start with ANCHOR\\__)
+
+          override_browser_configuration: Override browser configuration for this execution
+
+          session_id: Optional existing session ID to use
+
+          task_session_id: Optional task-specific session ID
+
+          version: Version to run (draft, latest, or version number)
+
+          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/task/run",
+            body=await async_maybe_transform(
+                {
+                    "task_id": task_id,
+                    "inputs": inputs,
+                    "override_browser_configuration": override_browser_configuration,
+                    "session_id": session_id,
+                    "task_session_id": task_session_id,
+                    "version": version,
+                },
+                run_execute_params.RunExecuteParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=RunExecuteResponse,
+        )
+
+
+class TaskResourceWithRawResponse:
+    def __init__(self, task: TaskResource) -> None:
+        self._task = task
+
+        self.create = to_raw_response_wrapper(
+            task.create,
+        )
+        self.list = to_raw_response_wrapper(
+            task.list,
+        )
+        self.run = to_raw_response_wrapper(
+            task.run,
+        )
+
+
+class AsyncTaskResourceWithRawResponse:
+    def __init__(self, task: AsyncTaskResource) -> None:
+        self._task = task
+
+        self.create = async_to_raw_response_wrapper(
+            task.create,
+        )
+        self.list = async_to_raw_response_wrapper(
+            task.list,
+        )
+        self.run = async_to_raw_response_wrapper(
+            task.run,
+        )
+
+
+class TaskResourceWithStreamingResponse:
+    def __init__(self, task: TaskResource) -> None:
+        self._task = task
+
+        self.create = to_streamed_response_wrapper(
+            task.create,
+        )
+        self.list = to_streamed_response_wrapper(
+            task.list,
+        )
+        self.run = to_streamed_response_wrapper(
+            task.run,
+        )
+
+
+class AsyncTaskResourceWithStreamingResponse:
+    def __init__(self, task: AsyncTaskResource) -> None:
+        self._task = task
+
+        self.create = async_to_streamed_response_wrapper(
+            task.create,
+        )
+        self.list = async_to_streamed_response_wrapper(
+            task.list,
+        )
+        self.run = async_to_streamed_response_wrapper(
+            task.run,
+        )

anchorbrowser/types/__init__.py

@@ -3,14 +3,17 @@
 from __future__ import annotations
 
 from .shared import SuccessResponse as SuccessResponse
+from .task_list_params import TaskListParams as TaskListParams
 from .extension_manifest import ExtensionManifest as ExtensionManifest
+from .task_create_params import TaskCreateParams as TaskCreateParams
+from .task_list_response import TaskListResponse as TaskListResponse
 from .event_signal_params import EventSignalParams as EventSignalParams
 from .session_goto_params import SessionGotoParams as SessionGotoParams
 from .session_paste_params import SessionPasteParams as SessionPasteParams
+from .task_create_response import TaskCreateResponse as TaskCreateResponse
 from .event_wait_for_params import EventWaitForParams as EventWaitForParams
 from .profile_create_params import ProfileCreateParams as ProfileCreateParams
 from .profile_list_response import ProfileListResponse as ProfileListResponse
-from .profile_update_params import ProfileUpdateParams as ProfileUpdateParams
 from .session_copy_response import SessionCopyResponse as SessionCopyResponse
 from .session_create_params import SessionCreateParams as SessionCreateParams
 from .session_goto_response import SessionGotoResponse as SessionGotoResponse
@@ -27,13 +30,16 @@ from .profile_retrieve_response import ProfileRetrieveResponse as ProfileRetriev
 from .session_retrieve_response import SessionRetrieveResponse as SessionRetrieveResponse
 from .tool_fetch_webpage_params import ToolFetchWebpageParams as ToolFetchWebpageParams
 from .session_upload_file_params import SessionUploadFileParams as SessionUploadFileParams
+from .batch_session_create_params import BatchSessionCreateParams as BatchSessionCreateParams
 from .extension_retrieve_response import ExtensionRetrieveResponse as ExtensionRetrieveResponse
 from .session_list_pages_response import SessionListPagesResponse as SessionListPagesResponse
 from .tool_fetch_webpage_response import ToolFetchWebpageResponse as ToolFetchWebpageResponse
 from .session_drag_and_drop_params import SessionDragAndDropParams as SessionDragAndDropParams
 from .session_upload_file_response import SessionUploadFileResponse as SessionUploadFileResponse
 from .tool_perform_web_task_params import ToolPerformWebTaskParams as ToolPerformWebTaskParams
+from .batch_session_create_response import BatchSessionCreateResponse as BatchSessionCreateResponse
 from .session_drag_and_drop_response import SessionDragAndDropResponse as SessionDragAndDropResponse
 from .tool_perform_web_task_response import ToolPerformWebTaskResponse as ToolPerformWebTaskResponse
 from .tool_screenshot_webpage_params import ToolScreenshotWebpageParams as ToolScreenshotWebpageParams
+from .batch_session_retrieve_response import BatchSessionRetrieveResponse as BatchSessionRetrieveResponse
 from .session_retrieve_downloads_response import SessionRetrieveDownloadsResponse as SessionRetrieveDownloadsResponse