anchorbrowser 0.3.12__py3-none-any.whl → 0.4.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
anchorbrowser/_client.py CHANGED
@@ -21,7 +21,7 @@ from ._types import (
21
21
  )
22
22
  from ._utils import is_given, get_async_library
23
23
  from ._version import __version__
24
- from .resources import task, agent, tools, events, browser, profiles, extensions, batch_sessions
24
+ from .resources import task, agent, tools, events, browser, profiles, extensions, identities
25
25
  from ._streaming import Stream as Stream, AsyncStream as AsyncStream
26
26
  from ._exceptions import APIStatusError, AnchorbrowserError
27
27
  from ._base_client import (
@@ -51,8 +51,8 @@ class Anchorbrowser(SyncAPIClient):
51
51
  browser: browser.BrowserResource
52
52
  agent: agent.AgentResource
53
53
  events: events.EventsResource
54
- batch_sessions: batch_sessions.BatchSessionsResource
55
54
  task: task.TaskResource
55
+ identities: identities.IdentitiesResource
56
56
  with_raw_response: AnchorbrowserWithRawResponse
57
57
  with_streaming_response: AnchorbrowserWithStreamedResponse
58
58
 
@@ -117,8 +117,8 @@ class Anchorbrowser(SyncAPIClient):
117
117
  self.browser = browser.BrowserResource(self)
118
118
  self.agent = agent.AgentResource(self)
119
119
  self.events = events.EventsResource(self)
120
- self.batch_sessions = batch_sessions.BatchSessionsResource(self)
121
120
  self.task = task.TaskResource(self)
121
+ self.identities = identities.IdentitiesResource(self)
122
122
  self.with_raw_response = AnchorbrowserWithRawResponse(self)
123
123
  self.with_streaming_response = AnchorbrowserWithStreamedResponse(self)
124
124
 
@@ -235,8 +235,8 @@ class AsyncAnchorbrowser(AsyncAPIClient):
235
235
  browser: browser.AsyncBrowserResource
236
236
  agent: agent.AsyncAgentResource
237
237
  events: events.AsyncEventsResource
238
- batch_sessions: batch_sessions.AsyncBatchSessionsResource
239
238
  task: task.AsyncTaskResource
239
+ identities: identities.AsyncIdentitiesResource
240
240
  with_raw_response: AsyncAnchorbrowserWithRawResponse
241
241
  with_streaming_response: AsyncAnchorbrowserWithStreamedResponse
242
242
 
@@ -301,8 +301,8 @@ class AsyncAnchorbrowser(AsyncAPIClient):
301
301
  self.browser = browser.AsyncBrowserResource(self)
302
302
  self.agent = agent.AsyncAgentResource(self)
303
303
  self.events = events.AsyncEventsResource(self)
304
- self.batch_sessions = batch_sessions.AsyncBatchSessionsResource(self)
305
304
  self.task = task.AsyncTaskResource(self)
305
+ self.identities = identities.AsyncIdentitiesResource(self)
306
306
  self.with_raw_response = AsyncAnchorbrowserWithRawResponse(self)
307
307
  self.with_streaming_response = AsyncAnchorbrowserWithStreamedResponse(self)
308
308
 
@@ -420,8 +420,8 @@ class AnchorbrowserWithRawResponse:
420
420
  self.browser = browser.BrowserResourceWithRawResponse(client.browser)
421
421
  self.agent = agent.AgentResourceWithRawResponse(client.agent)
422
422
  self.events = events.EventsResourceWithRawResponse(client.events)
423
- self.batch_sessions = batch_sessions.BatchSessionsResourceWithRawResponse(client.batch_sessions)
424
423
  self.task = task.TaskResourceWithRawResponse(client.task)
424
+ self.identities = identities.IdentitiesResourceWithRawResponse(client.identities)
425
425
 
426
426
 
427
427
  class AsyncAnchorbrowserWithRawResponse:
@@ -433,8 +433,8 @@ class AsyncAnchorbrowserWithRawResponse:
433
433
  self.browser = browser.AsyncBrowserResourceWithRawResponse(client.browser)
434
434
  self.agent = agent.AsyncAgentResourceWithRawResponse(client.agent)
435
435
  self.events = events.AsyncEventsResourceWithRawResponse(client.events)
436
- self.batch_sessions = batch_sessions.AsyncBatchSessionsResourceWithRawResponse(client.batch_sessions)
437
436
  self.task = task.AsyncTaskResourceWithRawResponse(client.task)
437
+ self.identities = identities.AsyncIdentitiesResourceWithRawResponse(client.identities)
438
438
 
439
439
 
440
440
  class AnchorbrowserWithStreamedResponse:
@@ -446,8 +446,8 @@ class AnchorbrowserWithStreamedResponse:
446
446
  self.browser = browser.BrowserResourceWithStreamingResponse(client.browser)
447
447
  self.agent = agent.AgentResourceWithStreamingResponse(client.agent)
448
448
  self.events = events.EventsResourceWithStreamingResponse(client.events)
449
- self.batch_sessions = batch_sessions.BatchSessionsResourceWithStreamingResponse(client.batch_sessions)
450
449
  self.task = task.TaskResourceWithStreamingResponse(client.task)
450
+ self.identities = identities.IdentitiesResourceWithStreamingResponse(client.identities)
451
451
 
452
452
 
453
453
  class AsyncAnchorbrowserWithStreamedResponse:
@@ -459,8 +459,8 @@ class AsyncAnchorbrowserWithStreamedResponse:
459
459
  self.browser = browser.AsyncBrowserResourceWithStreamingResponse(client.browser)
460
460
  self.agent = agent.AsyncAgentResourceWithStreamingResponse(client.agent)
461
461
  self.events = events.AsyncEventsResourceWithStreamingResponse(client.events)
462
- self.batch_sessions = batch_sessions.AsyncBatchSessionsResourceWithStreamingResponse(client.batch_sessions)
463
462
  self.task = task.AsyncTaskResourceWithStreamingResponse(client.task)
463
+ self.identities = identities.AsyncIdentitiesResourceWithStreamingResponse(client.identities)
464
464
 
465
465
 
466
466
  Client = Anchorbrowser
anchorbrowser/_types.py CHANGED
@@ -243,6 +243,9 @@ _T_co = TypeVar("_T_co", covariant=True)
243
243
  if TYPE_CHECKING:
244
244
  # This works because str.__contains__ does not accept object (either in typeshed or at runtime)
245
245
  # https://github.com/hauntsaninja/useful_types/blob/5e9710f3875107d068e7679fd7fec9cfab0eff3b/useful_types/__init__.py#L285
246
+ #
247
+ # Note: index() and count() methods are intentionally omitted to allow pyright to properly
248
+ # infer TypedDict types when dict literals are used in lists assigned to SequenceNotStr.
246
249
  class SequenceNotStr(Protocol[_T_co]):
247
250
  @overload
248
251
  def __getitem__(self, index: SupportsIndex, /) -> _T_co: ...
@@ -251,8 +254,6 @@ if TYPE_CHECKING:
251
254
  def __contains__(self, value: object, /) -> bool: ...
252
255
  def __len__(self) -> int: ...
253
256
  def __iter__(self) -> Iterator[_T_co]: ...
254
- def index(self, value: Any, start: int = 0, stop: int = ..., /) -> int: ...
255
- def count(self, value: Any, /) -> int: ...
256
257
  def __reversed__(self) -> Iterator[_T_co]: ...
257
258
  else:
258
259
  # just point this to a normal `Sequence` at runtime to avoid having to special case
anchorbrowser/_version.py CHANGED
@@ -1,4 +1,4 @@
1
1
  # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
2
 
3
3
  __title__ = "anchorbrowser"
4
- __version__ = "0.3.12" # x-release-please-version
4
+ __version__ = "0.4.0" # x-release-please-version
@@ -48,13 +48,13 @@ from .extensions import (
48
48
  ExtensionsResourceWithStreamingResponse,
49
49
  AsyncExtensionsResourceWithStreamingResponse,
50
50
  )
51
- from .batch_sessions import (
52
- BatchSessionsResource,
53
- AsyncBatchSessionsResource,
54
- BatchSessionsResourceWithRawResponse,
55
- AsyncBatchSessionsResourceWithRawResponse,
56
- BatchSessionsResourceWithStreamingResponse,
57
- AsyncBatchSessionsResourceWithStreamingResponse,
51
+ from .identities import (
52
+ IdentitiesResource,
53
+ AsyncIdentitiesResource,
54
+ IdentitiesResourceWithRawResponse,
55
+ AsyncIdentitiesResourceWithRawResponse,
56
+ IdentitiesResourceWithStreamingResponse,
57
+ AsyncIdentitiesResourceWithStreamingResponse,
58
58
  )
59
59
 
60
60
  __all__ = [
@@ -88,16 +88,16 @@ __all__ = [
88
88
  "AsyncEventsResourceWithRawResponse",
89
89
  "EventsResourceWithStreamingResponse",
90
90
  "AsyncEventsResourceWithStreamingResponse",
91
- "BatchSessionsResource",
92
- "AsyncBatchSessionsResource",
93
- "BatchSessionsResourceWithRawResponse",
94
- "AsyncBatchSessionsResourceWithRawResponse",
95
- "BatchSessionsResourceWithStreamingResponse",
96
- "AsyncBatchSessionsResourceWithStreamingResponse",
97
91
  "TaskResource",
98
92
  "AsyncTaskResource",
99
93
  "TaskResourceWithRawResponse",
100
94
  "AsyncTaskResourceWithRawResponse",
101
95
  "TaskResourceWithStreamingResponse",
102
96
  "AsyncTaskResourceWithStreamingResponse",
97
+ "IdentitiesResource",
98
+ "AsyncIdentitiesResource",
99
+ "IdentitiesResourceWithRawResponse",
100
+ "AsyncIdentitiesResourceWithRawResponse",
101
+ "IdentitiesResourceWithStreamingResponse",
102
+ "AsyncIdentitiesResourceWithStreamingResponse",
103
103
  ]
@@ -0,0 +1,163 @@
1
+ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ from __future__ import annotations
4
+
5
+ import httpx
6
+
7
+ from .._types import Body, Query, Headers, NotGiven, not_given
8
+ from .._compat import cached_property
9
+ from .._resource import SyncAPIResource, AsyncAPIResource
10
+ from .._response import (
11
+ to_raw_response_wrapper,
12
+ to_streamed_response_wrapper,
13
+ async_to_raw_response_wrapper,
14
+ async_to_streamed_response_wrapper,
15
+ )
16
+ from .._base_client import make_request_options
17
+ from ..types.identity_retrieve_credentials_response import IdentityRetrieveCredentialsResponse
18
+
19
+ __all__ = ["IdentitiesResource", "AsyncIdentitiesResource"]
20
+
21
+
22
+ class IdentitiesResource(SyncAPIResource):
23
+ @cached_property
24
+ def with_raw_response(self) -> IdentitiesResourceWithRawResponse:
25
+ """
26
+ This property can be used as a prefix for any HTTP method call to return
27
+ the raw response object instead of the parsed content.
28
+
29
+ For more information, see https://www.github.com/anchorbrowser/AnchorBrowser-SDK-Python#accessing-raw-response-data-eg-headers
30
+ """
31
+ return IdentitiesResourceWithRawResponse(self)
32
+
33
+ @cached_property
34
+ def with_streaming_response(self) -> IdentitiesResourceWithStreamingResponse:
35
+ """
36
+ An alternative to `.with_raw_response` that doesn't eagerly read the response body.
37
+
38
+ For more information, see https://www.github.com/anchorbrowser/AnchorBrowser-SDK-Python#with_streaming_response
39
+ """
40
+ return IdentitiesResourceWithStreamingResponse(self)
41
+
42
+ def retrieve_credentials(
43
+ self,
44
+ identity_id: str,
45
+ *,
46
+ # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
47
+ # The extra values given here take precedence over values defined on the client or passed to this method.
48
+ extra_headers: Headers | None = None,
49
+ extra_query: Query | None = None,
50
+ extra_body: Body | None = None,
51
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
52
+ ) -> IdentityRetrieveCredentialsResponse:
53
+ """
54
+ Retrieves the credentials for a specific identity.
55
+
56
+ Args:
57
+ extra_headers: Send extra headers
58
+
59
+ extra_query: Add additional query parameters to the request
60
+
61
+ extra_body: Add additional JSON properties to the request
62
+
63
+ timeout: Override the client-level default timeout for this request, in seconds
64
+ """
65
+ if not identity_id:
66
+ raise ValueError(f"Expected a non-empty value for `identity_id` but received {identity_id!r}")
67
+ return self._get(
68
+ f"/v1/identities/{identity_id}/credentials",
69
+ options=make_request_options(
70
+ extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
71
+ ),
72
+ cast_to=IdentityRetrieveCredentialsResponse,
73
+ )
74
+
75
+
76
+ class AsyncIdentitiesResource(AsyncAPIResource):
77
+ @cached_property
78
+ def with_raw_response(self) -> AsyncIdentitiesResourceWithRawResponse:
79
+ """
80
+ This property can be used as a prefix for any HTTP method call to return
81
+ the raw response object instead of the parsed content.
82
+
83
+ For more information, see https://www.github.com/anchorbrowser/AnchorBrowser-SDK-Python#accessing-raw-response-data-eg-headers
84
+ """
85
+ return AsyncIdentitiesResourceWithRawResponse(self)
86
+
87
+ @cached_property
88
+ def with_streaming_response(self) -> AsyncIdentitiesResourceWithStreamingResponse:
89
+ """
90
+ An alternative to `.with_raw_response` that doesn't eagerly read the response body.
91
+
92
+ For more information, see https://www.github.com/anchorbrowser/AnchorBrowser-SDK-Python#with_streaming_response
93
+ """
94
+ return AsyncIdentitiesResourceWithStreamingResponse(self)
95
+
96
+ async def retrieve_credentials(
97
+ self,
98
+ identity_id: str,
99
+ *,
100
+ # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
101
+ # The extra values given here take precedence over values defined on the client or passed to this method.
102
+ extra_headers: Headers | None = None,
103
+ extra_query: Query | None = None,
104
+ extra_body: Body | None = None,
105
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
106
+ ) -> IdentityRetrieveCredentialsResponse:
107
+ """
108
+ Retrieves the credentials for a specific identity.
109
+
110
+ Args:
111
+ extra_headers: Send extra headers
112
+
113
+ extra_query: Add additional query parameters to the request
114
+
115
+ extra_body: Add additional JSON properties to the request
116
+
117
+ timeout: Override the client-level default timeout for this request, in seconds
118
+ """
119
+ if not identity_id:
120
+ raise ValueError(f"Expected a non-empty value for `identity_id` but received {identity_id!r}")
121
+ return await self._get(
122
+ f"/v1/identities/{identity_id}/credentials",
123
+ options=make_request_options(
124
+ extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
125
+ ),
126
+ cast_to=IdentityRetrieveCredentialsResponse,
127
+ )
128
+
129
+
130
+ class IdentitiesResourceWithRawResponse:
131
+ def __init__(self, identities: IdentitiesResource) -> None:
132
+ self._identities = identities
133
+
134
+ self.retrieve_credentials = to_raw_response_wrapper(
135
+ identities.retrieve_credentials,
136
+ )
137
+
138
+
139
+ class AsyncIdentitiesResourceWithRawResponse:
140
+ def __init__(self, identities: AsyncIdentitiesResource) -> None:
141
+ self._identities = identities
142
+
143
+ self.retrieve_credentials = async_to_raw_response_wrapper(
144
+ identities.retrieve_credentials,
145
+ )
146
+
147
+
148
+ class IdentitiesResourceWithStreamingResponse:
149
+ def __init__(self, identities: IdentitiesResource) -> None:
150
+ self._identities = identities
151
+
152
+ self.retrieve_credentials = to_streamed_response_wrapper(
153
+ identities.retrieve_credentials,
154
+ )
155
+
156
+
157
+ class AsyncIdentitiesResourceWithStreamingResponse:
158
+ def __init__(self, identities: AsyncIdentitiesResource) -> None:
159
+ self._identities = identities
160
+
161
+ self.retrieve_credentials = async_to_streamed_response_wrapper(
162
+ identities.retrieve_credentials,
163
+ )
@@ -30,16 +30,16 @@ from .profile_retrieve_response import ProfileRetrieveResponse as ProfileRetriev
30
30
  from .session_retrieve_response import SessionRetrieveResponse as SessionRetrieveResponse
31
31
  from .tool_fetch_webpage_params import ToolFetchWebpageParams as ToolFetchWebpageParams
32
32
  from .session_upload_file_params import SessionUploadFileParams as SessionUploadFileParams
33
- from .batch_session_create_params import BatchSessionCreateParams as BatchSessionCreateParams
34
33
  from .extension_retrieve_response import ExtensionRetrieveResponse as ExtensionRetrieveResponse
35
34
  from .session_list_pages_response import SessionListPagesResponse as SessionListPagesResponse
36
35
  from .tool_fetch_webpage_response import ToolFetchWebpageResponse as ToolFetchWebpageResponse
37
36
  from .session_drag_and_drop_params import SessionDragAndDropParams as SessionDragAndDropParams
38
37
  from .session_upload_file_response import SessionUploadFileResponse as SessionUploadFileResponse
39
38
  from .tool_perform_web_task_params import ToolPerformWebTaskParams as ToolPerformWebTaskParams
40
- from .batch_session_create_response import BatchSessionCreateResponse as BatchSessionCreateResponse
41
39
  from .session_drag_and_drop_response import SessionDragAndDropResponse as SessionDragAndDropResponse
42
40
  from .tool_perform_web_task_response import ToolPerformWebTaskResponse as ToolPerformWebTaskResponse
43
41
  from .tool_screenshot_webpage_params import ToolScreenshotWebpageParams as ToolScreenshotWebpageParams
44
- from .batch_session_retrieve_response import BatchSessionRetrieveResponse as BatchSessionRetrieveResponse
45
42
  from .session_retrieve_downloads_response import SessionRetrieveDownloadsResponse as SessionRetrieveDownloadsResponse
43
+ from .identity_retrieve_credentials_response import (
44
+ IdentityRetrieveCredentialsResponse as IdentityRetrieveCredentialsResponse,
45
+ )
@@ -0,0 +1,72 @@
1
+ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ from typing import List, Union, Optional
4
+ from typing_extensions import Literal, TypeAlias
5
+
6
+ from .._models import BaseModel
7
+
8
+ __all__ = [
9
+ "IdentityRetrieveCredentialsResponse",
10
+ "Credential",
11
+ "CredentialUsernamePasswordCredentialSchema",
12
+ "CredentialAuthenticatorCredentialSchema",
13
+ "CredentialCustomCredentialSchema",
14
+ "CredentialCustomCredentialSchemaField",
15
+ ]
16
+
17
+
18
+ class CredentialUsernamePasswordCredentialSchema(BaseModel):
19
+ password: Optional[str] = None
20
+ """The password of the credential"""
21
+
22
+ type: Optional[Literal["username_password"]] = None
23
+ """The type of credential"""
24
+
25
+ username: Optional[str] = None
26
+ """The username of the credential"""
27
+
28
+
29
+ class CredentialAuthenticatorCredentialSchema(BaseModel):
30
+ otp: Optional[str] = None
31
+ """The OTP of the credential"""
32
+
33
+ secret: Optional[str] = None
34
+ """The secret of the credential"""
35
+
36
+ type: Optional[Literal["authenticator"]] = None
37
+ """The type of credential"""
38
+
39
+
40
+ class CredentialCustomCredentialSchemaField(BaseModel):
41
+ name: Optional[str] = None
42
+ """The name of the field"""
43
+
44
+ value: Optional[str] = None
45
+ """The value of the field"""
46
+
47
+
48
+ class CredentialCustomCredentialSchema(BaseModel):
49
+ fields: Optional[List[CredentialCustomCredentialSchemaField]] = None
50
+
51
+ type: Optional[Literal["custom"]] = None
52
+ """The type of credential"""
53
+
54
+
55
+ Credential: TypeAlias = Union[
56
+ CredentialUsernamePasswordCredentialSchema,
57
+ CredentialAuthenticatorCredentialSchema,
58
+ CredentialCustomCredentialSchema,
59
+ ]
60
+
61
+
62
+ class IdentityRetrieveCredentialsResponse(BaseModel):
63
+ id: Optional[str] = None
64
+ """The ID of the identity"""
65
+
66
+ credentials: Optional[List[Credential]] = None
67
+
68
+ name: Optional[str] = None
69
+ """The name of the identity"""
70
+
71
+ source: Optional[str] = None
72
+ """The url related to the identity"""
@@ -49,11 +49,15 @@ class SessionCreateParams(TypedDict, total=False):
49
49
 
50
50
 
51
51
  class BrowserAdblock(TypedDict, total=False):
52
+ """Configuration for ad-blocking."""
53
+
52
54
  active: bool
53
55
  """Enable or disable ad-blocking. Defaults to `true`."""
54
56
 
55
57
 
56
58
  class BrowserCaptchaSolver(TypedDict, total=False):
59
+ """Configuration for captcha-solving."""
60
+
57
61
  active: bool
58
62
  """Enable or disable captcha-solving.
59
63
 
@@ -62,6 +66,8 @@ class BrowserCaptchaSolver(TypedDict, total=False):
62
66
 
63
67
 
64
68
  class BrowserDisableWebSecurity(TypedDict, total=False):
69
+ """Configuration for disabling web security features."""
70
+
65
71
  active: bool
66
72
  """Whether to disable web security features (CORS, same-origin policy, etc.).
67
73
 
@@ -71,11 +77,17 @@ class BrowserDisableWebSecurity(TypedDict, total=False):
71
77
 
72
78
 
73
79
  class BrowserExtraStealth(TypedDict, total=False):
80
+ """
81
+ Configuration for extra stealth mode to enhance browser fingerprinting protection.
82
+ """
83
+
74
84
  active: bool
75
85
  """Enable or disable extra stealth mode."""
76
86
 
77
87
 
78
88
  class BrowserFullscreen(TypedDict, total=False):
89
+ """Configuration for fullscreen mode."""
90
+
79
91
  active: bool
80
92
  """Enable or disable fullscreen mode.
81
93
 
@@ -84,11 +96,15 @@ class BrowserFullscreen(TypedDict, total=False):
84
96
 
85
97
 
86
98
  class BrowserHeadless(TypedDict, total=False):
99
+ """Configuration for headless mode."""
100
+
87
101
  active: bool
88
102
  """Whether browser should be headless or headful. Defaults to `false`."""
89
103
 
90
104
 
91
105
  class BrowserP2pDownload(TypedDict, total=False):
106
+ """Configuration for peer-to-peer download capture functionality."""
107
+
92
108
  active: bool
93
109
  """Enable or disable P2P downloads.
94
110
 
@@ -98,6 +114,8 @@ class BrowserP2pDownload(TypedDict, total=False):
98
114
 
99
115
 
100
116
  class BrowserPopupBlocker(TypedDict, total=False):
117
+ """Configuration for popup blocking."""
118
+
101
119
  active: bool
102
120
  """Blocks popups, including ads and CAPTCHA consent banners.
103
121
 
@@ -106,6 +124,8 @@ class BrowserPopupBlocker(TypedDict, total=False):
106
124
 
107
125
 
108
126
  class BrowserProfile(TypedDict, total=False):
127
+ """Options for managing and persisting browser session profiles."""
128
+
109
129
  name: str
110
130
  """The name of the profile to be used during the browser session."""
111
131
 
@@ -117,6 +137,8 @@ class BrowserProfile(TypedDict, total=False):
117
137
 
118
138
 
119
139
  class BrowserViewport(TypedDict, total=False):
140
+ """Configuration for the browser's viewport size."""
141
+
120
142
  height: int
121
143
  """Height of the viewport in pixels. Defaults to `900`."""
122
144
 
@@ -125,6 +147,8 @@ class BrowserViewport(TypedDict, total=False):
125
147
 
126
148
 
127
149
  class Browser(TypedDict, total=False):
150
+ """Browser-specific configurations."""
151
+
128
152
  adblock: BrowserAdblock
129
153
  """Configuration for ad-blocking."""
130
154
 
@@ -194,6 +218,8 @@ class Integration(TypedDict, total=False):
194
218
 
195
219
 
196
220
  class SessionLiveView(TypedDict, total=False):
221
+ """Configuration for live viewing the browser session."""
222
+
197
223
  read_only: bool
198
224
  """Enable or disable read-only mode for live viewing. Defaults to `false`."""
199
225
 
@@ -437,11 +463,15 @@ SessionProxy: TypeAlias = Union[SessionProxyAnchorProxy, SessionProxyCustomProxy
437
463
 
438
464
 
439
465
  class SessionRecording(TypedDict, total=False):
466
+ """Configuration for session recording."""
467
+
440
468
  active: bool
441
469
  """Enable or disable video recording of the browser session. Defaults to `true`."""
442
470
 
443
471
 
444
472
  class SessionTimeout(TypedDict, total=False):
473
+ """Timeout configurations for the browser session."""
474
+
445
475
  idle_timeout: int
446
476
  """
447
477
  The amount of time (in minutes) the browser session waits for new connections
@@ -456,6 +486,8 @@ class SessionTimeout(TypedDict, total=False):
456
486
 
457
487
 
458
488
  class Session(TypedDict, total=False):
489
+ """Session-related configurations."""
490
+
459
491
  initial_url: str
460
492
  """The URL to navigate to when the browser session starts.
461
493
 
@@ -37,6 +37,8 @@ class TaskCreateParams(TypedDict, total=False):
37
37
 
38
38
 
39
39
  class BrowserConfigurationLiveView(TypedDict, total=False):
40
+ """Configuration for live viewing the browser session."""
41
+
40
42
  read_only: bool
41
43
  """Enable or disable read-only mode for live viewing. Defaults to `false`."""
42
44
 
@@ -279,11 +281,15 @@ BrowserConfigurationProxy: TypeAlias = Union[BrowserConfigurationProxyAnchorProx
279
281
 
280
282
 
281
283
  class BrowserConfigurationRecording(TypedDict, total=False):
284
+ """Configuration for session recording."""
285
+
282
286
  active: bool
283
287
  """Enable or disable video recording of the browser session. Defaults to `true`."""
284
288
 
285
289
 
286
290
  class BrowserConfigurationTimeout(TypedDict, total=False):
291
+ """Timeout configurations for the browser session."""
292
+
287
293
  idle_timeout: int
288
294
  """
289
295
  The amount of time (in minutes) the browser session waits for new connections
@@ -298,6 +304,8 @@ class BrowserConfigurationTimeout(TypedDict, total=False):
298
304
 
299
305
 
300
306
  class BrowserConfiguration(TypedDict, total=False):
307
+ """Browser configuration for task execution"""
308
+
301
309
  initial_url: str
302
310
  """The URL to navigate to when the browser session starts.
303
311
 
@@ -22,6 +22,8 @@ __all__ = [
22
22
 
23
23
 
24
24
  class DataBrowserConfigurationLiveView(BaseModel):
25
+ """Configuration for live viewing the browser session."""
26
+
25
27
  read_only: Optional[bool] = None
26
28
  """Enable or disable read-only mode for live viewing. Defaults to `false`."""
27
29
 
@@ -268,11 +270,15 @@ DataBrowserConfigurationProxy: TypeAlias = Union[
268
270
 
269
271
 
270
272
  class DataBrowserConfigurationRecording(BaseModel):
273
+ """Configuration for session recording."""
274
+
271
275
  active: Optional[bool] = None
272
276
  """Enable or disable video recording of the browser session. Defaults to `true`."""
273
277
 
274
278
 
275
279
  class DataBrowserConfigurationTimeout(BaseModel):
280
+ """Timeout configurations for the browser session."""
281
+
276
282
  idle_timeout: Optional[int] = None
277
283
  """
278
284
  The amount of time (in minutes) the browser session waits for new connections
@@ -287,6 +293,8 @@ class DataBrowserConfigurationTimeout(BaseModel):
287
293
 
288
294
 
289
295
  class DataBrowserConfiguration(BaseModel):
296
+ """Browser configuration for task execution"""
297
+
290
298
  initial_url: Optional[str] = None
291
299
  """The URL to navigate to when the browser session starts.
292
300
 
@@ -23,6 +23,8 @@ __all__ = [
23
23
 
24
24
 
25
25
  class DataTaskBrowserConfigurationLiveView(BaseModel):
26
+ """Configuration for live viewing the browser session."""
27
+
26
28
  read_only: Optional[bool] = None
27
29
  """Enable or disable read-only mode for live viewing. Defaults to `false`."""
28
30
 
@@ -269,11 +271,15 @@ DataTaskBrowserConfigurationProxy: TypeAlias = Union[
269
271
 
270
272
 
271
273
  class DataTaskBrowserConfigurationRecording(BaseModel):
274
+ """Configuration for session recording."""
275
+
272
276
  active: Optional[bool] = None
273
277
  """Enable or disable video recording of the browser session. Defaults to `true`."""
274
278
 
275
279
 
276
280
  class DataTaskBrowserConfigurationTimeout(BaseModel):
281
+ """Timeout configurations for the browser session."""
282
+
277
283
  idle_timeout: Optional[int] = None
278
284
  """
279
285
  The amount of time (in minutes) the browser session waits for new connections
@@ -288,6 +294,8 @@ class DataTaskBrowserConfigurationTimeout(BaseModel):
288
294
 
289
295
 
290
296
  class DataTaskBrowserConfiguration(BaseModel):
297
+ """Browser configuration for task execution"""
298
+
291
299
  initial_url: Optional[str] = None
292
300
  """The URL to navigate to when the browser session starts.
293
301
 
@@ -39,6 +39,8 @@ class RunExecuteParams(TypedDict, total=False):
39
39
 
40
40
 
41
41
  class OverrideBrowserConfigurationLiveView(TypedDict, total=False):
42
+ """Configuration for live viewing the browser session."""
43
+
42
44
  read_only: bool
43
45
  """Enable or disable read-only mode for live viewing. Defaults to `false`."""
44
46
 
@@ -283,11 +285,15 @@ OverrideBrowserConfigurationProxy: TypeAlias = Union[
283
285
 
284
286
 
285
287
  class OverrideBrowserConfigurationRecording(TypedDict, total=False):
288
+ """Configuration for session recording."""
289
+
286
290
  active: bool
287
291
  """Enable or disable video recording of the browser session. Defaults to `true`."""
288
292
 
289
293
 
290
294
  class OverrideBrowserConfigurationTimeout(TypedDict, total=False):
295
+ """Timeout configurations for the browser session."""
296
+
291
297
  idle_timeout: int
292
298
  """
293
299
  The amount of time (in minutes) the browser session waits for new connections
@@ -302,6 +308,8 @@ class OverrideBrowserConfigurationTimeout(TypedDict, total=False):
302
308
 
303
309
 
304
310
  class OverrideBrowserConfiguration(TypedDict, total=False):
311
+ """Override browser configuration for this execution"""
312
+
305
313
  initial_url: str
306
314
  """The URL to navigate to when the browser session starts.
307
315