browser-use-sdk 1.2.0 → 2.0.1

package/src/resources/agent-profiles.ts

@@ -1,245 +0,0 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-import { APIResource } from '../core/resource';
-import { APIPromise } from '../core/api-promise';
-import { buildHeaders } from '../internal/headers';
-import { RequestOptions } from '../internal/request-options';
-import { path } from '../internal/utils/path';
-
-export class AgentProfiles extends APIResource {
-  /**
-   * Create a new agent profile for the authenticated user.
-   *
-   * Agent profiles define how your AI agents behave during tasks. You can create
-   * multiple profiles for different use cases (e.g., customer support, data
-   * analysis, web scraping). Free users can create 1 profile; paid users can create
-   * unlimited profiles.
-   *
-   * Key features you can configure:
-   *
-   * - System prompt: The core instructions that define the agent's personality and
-   *   behavior
-   * - Allowed domains: Restrict which websites the agent can access
-   * - Max steps: Limit how many actions the agent can take in a single task
-   * - Vision: Enable/disable the agent's ability to see and analyze screenshots
-   * - Thinking: Enable/disable the agent's reasoning process
-   *
-   * Args:
-   *
-   * - request: The agent profile configuration including name, description, and
-   *   behavior settings
-   *
-   * Returns:
-   *
-   * - The newly created agent profile with all its details
-   *
-   * Raises:
-   *
-   * - 402: If user needs a subscription to create additional profiles
-   */
-  create(body: AgentProfileCreateParams, options?: RequestOptions): APIPromise<AgentProfileView> {
-    return this._client.post('/agent-profiles', { body, ...options });
-  }
-
-  /**
-   * Get a specific agent profile by its ID.
-   *
-   * Retrieves the complete details of an agent profile, including all its
-   * configuration settings like system prompts, allowed domains, and behavior flags.
-   *
-   * Args:
-   *
-   * - profile_id: The unique identifier of the agent profile
-   *
-   * Returns:
-   *
-   * - Complete agent profile information
-   *
-   * Raises:
-   *
-   * - 404: If the user agent profile doesn't exist
-   */
-  retrieve(profileID: string, options?: RequestOptions): APIPromise<AgentProfileView> {
-    return this._client.get(path`/agent-profiles/${profileID}`, options);
-  }
-
-  /**
-   * Update an existing agent profile.
-   *
-   * Modify any aspect of an agent profile, such as its name, description, system
-   * prompt, or behavior settings. Only the fields you provide will be updated; other
-   * fields remain unchanged.
-   *
-   * Args:
-   *
-   * - profile_id: The unique identifier of the agent profile to update
-   * - request: The fields to update (only provided fields will be changed)
-   *
-   * Returns:
-   *
-   * - The updated agent profile with all its current details
-   *
-   * Raises:
-   *
-   * - 404: If the user agent profile doesn't exist
-   */
-  update(
-    profileID: string,
-    body: AgentProfileUpdateParams,
-    options?: RequestOptions,
-  ): APIPromise<AgentProfileView> {
-    return this._client.patch(path`/agent-profiles/${profileID}`, { body, ...options });
-  }
-
-  /**
-   * Get a paginated list of all agent profiles for the authenticated user.
-   *
-   * Agent profiles define how your AI agents behave, including their personality,
-   * capabilities, and limitations. Use this endpoint to see all your configured
-   * agent profiles.
-   *
-   * Returns:
-   *
-   * - A paginated list of agent profiles
-   * - Total count of profiles
-   * - Page information for navigation
-   */
-  list(
-    query: AgentProfileListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<AgentProfileListResponse> {
-    return this._client.get('/agent-profiles', { query, ...options });
-  }
-
-  /**
-   * Delete an agent profile.
-   *
-   * Permanently removes an agent profile and all its configuration. This action
-   * cannot be undone. Any tasks that were using this profile will continue to work,
-   * but you won't be able to create new tasks with the deleted profile.
-   *
-   * Args:
-   *
-   * - profile_id: The unique identifier of the agent profile to delete
-   *
-   * Returns:
-   *
-   * - 204 No Content on successful deletion (idempotent)
-   */
-  delete(profileID: string, options?: RequestOptions): APIPromise<void> {
-    return this._client.delete(path`/agent-profiles/${profileID}`, {
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
-  }
-}
-
-/**
- * View model for representing an agent profile
- *
- * Attributes: id: Unique identifier for the profile name: Display name for the
- * profile description: Optional description of the profile highlight_elements:
- * Whether to highlight elements during agent interaction with the browser
- * max_agent_steps: Maximum number of steps the agent can take before stopping
- * allowed_domains: List of domains the agent is allowed to access flash_mode:
- * Whether flash mode is enabled thinking: Whether thinking mode is enabled vision:
- * Whether vision capabilities are enabled custom_system_prompt_extension: Optional
- * custom system prompt for the agent created_at: Timestamp when the profile was
- * created updated_at: Timestamp when the profile was last updated
- */
-export interface AgentProfileView {
-  id: string;
-
-  allowedDomains: Array<string>;
-
-  createdAt: string;
-
-  customSystemPromptExtension: string;
-
-  description: string;
-
-  flashMode: boolean;
-
-  highlightElements: boolean;
-
-  maxAgentSteps: number;
-
-  name: string;
-
-  thinking: boolean;
-
-  updatedAt: string;
-
-  vision: boolean;
-}
-
-/**
- * Response model for paginated agent profile list requests
- *
- * Attributes: items: List of agent profile views for the current page
- */
-export interface AgentProfileListResponse {
-  items: Array<AgentProfileView>;
-
-  pageNumber: number;
-
-  pageSize: number;
-
-  totalItems: number;
-}
-
-export interface AgentProfileCreateParams {
-  name: string;
-
-  allowedDomains?: Array<string>;
-
-  customSystemPromptExtension?: string;
-
-  description?: string;
-
-  flashMode?: boolean;
-
-  highlightElements?: boolean;
-
-  maxAgentSteps?: number;
-
-  thinking?: boolean;
-
-  vision?: boolean;
-}
-
-export interface AgentProfileUpdateParams {
-  allowedDomains?: Array<string> | null;
-
-  customSystemPromptExtension?: string | null;
-
-  description?: string | null;
-
-  flashMode?: boolean | null;
-
-  highlightElements?: boolean | null;
-
-  maxAgentSteps?: number | null;
-
-  name?: string | null;
-
-  thinking?: boolean | null;
-
-  vision?: boolean | null;
-}
-
-export interface AgentProfileListParams {
-  pageNumber?: number;
-
-  pageSize?: number;
-}
-
-export declare namespace AgentProfiles {
-  export {
-    type AgentProfileView as AgentProfileView,
-    type AgentProfileListResponse as AgentProfileListResponse,
-    type AgentProfileCreateParams as AgentProfileCreateParams,
-    type AgentProfileUpdateParams as AgentProfileUpdateParams,
-    type AgentProfileListParams as AgentProfileListParams,
-  };
-}

package/src/resources/browser-profiles.ts

@@ -1,255 +0,0 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-import { APIResource } from '../core/resource';
-import { APIPromise } from '../core/api-promise';
-import { buildHeaders } from '../internal/headers';
-import { RequestOptions } from '../internal/request-options';
-import { path } from '../internal/utils/path';
-
-export class BrowserProfiles extends APIResource {
-  /**
-   * Create a new browser profile for the authenticated user.
-   *
-   * Browser profiles define how your web browsers behave during AI agent tasks. You
-   * can create multiple profiles for different use cases (e.g., mobile testing,
-   * desktop browsing, proxy-enabled scraping). Free users can create up to 10
-   * profiles; paid users can create unlimited profiles.
-   *
-   * Key features you can configure:
-   *
-   * - Viewport dimensions: Set the browser window size for consistent rendering
-   * - Mobile emulation: Enable mobile device simulation
-   * - Proxy settings: Route traffic through specific locations or proxy servers
-   * - Ad blocking: Enable/disable ad blocking for cleaner browsing
-   * - Cache persistence: Choose whether to save browser data between sessions
-   *
-   * Args:
-   *
-   * - request: The browser profile configuration including name, description, and
-   *   browser settings
-   *
-   * Returns:
-   *
-   * - The newly created browser profile with all its details
-   *
-   * Raises:
-   *
-   * - 402: If user needs a subscription to create additional profiles
-   */
-  create(body: BrowserProfileCreateParams, options?: RequestOptions): APIPromise<BrowserProfileView> {
-    return this._client.post('/browser-profiles', { body, ...options });
-  }
-
-  /**
-   * Get a specific browser profile by its ID.
-   *
-   * Retrieves the complete details of a browser profile, including all its
-   * configuration settings like viewport dimensions, proxy settings, and behavior
-   * flags.
-   *
-   * Args:
-   *
-   * - profile_id: The unique identifier of the browser profile
-   *
-   * Returns:
-   *
-   * - Complete browser profile information
-   *
-   * Raises:
-   *
-   * - 404: If the user browser profile doesn't exist
-   */
-  retrieve(profileID: string, options?: RequestOptions): APIPromise<BrowserProfileView> {
-    return this._client.get(path`/browser-profiles/${profileID}`, options);
-  }
-
-  /**
-   * Update an existing browser profile.
-   *
-   * Modify any aspect of a browser profile, such as its name, description, viewport
-   * settings, or proxy configuration. Only the fields you provide will be updated;
-   * other fields remain unchanged.
-   *
-   * Args:
-   *
-   * - profile_id: The unique identifier of the browser profile to update
-   * - request: The fields to update (only provided fields will be changed)
-   *
-   * Returns:
-   *
-   * - The updated browser profile with all its current details
-   *
-   * Raises:
-   *
-   * - 404: If the user browser profile doesn't exist
-   */
-  update(
-    profileID: string,
-    body: BrowserProfileUpdateParams,
-    options?: RequestOptions,
-  ): APIPromise<BrowserProfileView> {
-    return this._client.patch(path`/browser-profiles/${profileID}`, { body, ...options });
-  }
-
-  /**
-   * Get a paginated list of all browser profiles for the authenticated user.
-   *
-   * Browser profiles define how your web browsers behave during AI agent tasks,
-   * including settings like viewport size, mobile emulation, proxy configuration,
-   * and ad blocking. Use this endpoint to see all your configured browser profiles.
-   *
-   * Returns:
-   *
-   * - A paginated list of browser profiles
-   * - Total count of profiles
-   * - Page information for navigation
-   */
-  list(
-    query: BrowserProfileListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<BrowserProfileListResponse> {
-    return this._client.get('/browser-profiles', { query, ...options });
-  }
-
-  /**
-   * Delete a browser profile.
-   *
-   * Permanently removes a browser profile and all its configuration. This action
-   * cannot be undone. The profile will also be removed from the browser service. Any
-   * active sessions using this profile will continue to work, but you won't be able
-   * to create new sessions with the deleted profile.
-   *
-   * Args:
-   *
-   * - profile_id: The unique identifier of the browser profile to delete
-   *
-   * Returns:
-   *
-   * - 204 No Content on successful deletion (idempotent)
-   */
-  delete(profileID: string, options?: RequestOptions): APIPromise<void> {
-    return this._client.delete(path`/browser-profiles/${profileID}`, {
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
-  }
-}
-
-/**
- * View model for representing a browser profile
- *
- * Attributes: id: Unique identifier for the profile name: Display name for the
- * profile description: Optional description of the profile persist: Whether
- * browser state should persist between sessions ad_blocker: Whether ad blocking is
- * enabled proxy: Whether proxy is enabled proxy_country_code: Country code for
- * proxy location store_cache: Whether to store browser cache
- * browser_viewport_width: Browser viewport width in pixels
- * browser_viewport_height: Browser viewport height in pixels is_mobile: Whether
- * the browser should be in mobile view created_at: Timestamp when the profile was
- * created updated_at: Timestamp when the profile was last updated
- */
-export interface BrowserProfileView {
-  id: string;
-
-  adBlocker: boolean;
-
-  browserViewportHeight: number;
-
-  browserViewportWidth: number;
-
-  createdAt: string;
-
-  description: string;
-
-  isMobile: boolean;
-
-  name: string;
-
-  persist: boolean;
-
-  proxy: boolean;
-
-  proxyCountryCode: ProxyCountryCode;
-
-  storeCache: boolean;
-
-  updatedAt: string;
-}
-
-export type ProxyCountryCode = 'us' | 'uk' | 'fr' | 'it' | 'jp' | 'au' | 'de' | 'fi' | 'ca' | 'in';
-
-/**
- * Response model for paginated browser profile list requests
- *
- * Attributes: items: List of browser profile views for the current page
- */
-export interface BrowserProfileListResponse {
-  items: Array<BrowserProfileView>;
-
-  pageNumber: number;
-
-  pageSize: number;
-
-  totalItems: number;
-}
-
-export interface BrowserProfileCreateParams {
-  name: string;
-
-  adBlocker?: boolean;
-
-  browserViewportHeight?: number;
-
-  browserViewportWidth?: number;
-
-  description?: string;
-
-  isMobile?: boolean;
-
-  persist?: boolean;
-
-  proxy?: boolean;
-
-  proxyCountryCode?: ProxyCountryCode;
-
-  storeCache?: boolean;
-}
-
-export interface BrowserProfileUpdateParams {
-  adBlocker?: boolean | null;
-
-  browserViewportHeight?: number | null;
-
-  browserViewportWidth?: number | null;
-
-  description?: string | null;
-
-  isMobile?: boolean | null;
-
-  name?: string | null;
-
-  persist?: boolean | null;
-
-  proxy?: boolean | null;
-
-  proxyCountryCode?: ProxyCountryCode | null;
-
-  storeCache?: boolean | null;
-}
-
-export interface BrowserProfileListParams {
-  pageNumber?: number;
-
-  pageSize?: number;
-}
-
-export declare namespace BrowserProfiles {
-  export {
-    type BrowserProfileView as BrowserProfileView,
-    type ProxyCountryCode as ProxyCountryCode,
-    type BrowserProfileListResponse as BrowserProfileListResponse,
-    type BrowserProfileCreateParams as BrowserProfileCreateParams,
-    type BrowserProfileUpdateParams as BrowserProfileUpdateParams,
-    type BrowserProfileListParams as BrowserProfileListParams,
-  };
-}

package/src/resources/index.ts

@@ -1,46 +0,0 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-export {
-  AgentProfiles,
-  type AgentProfileView,
-  type AgentProfileListResponse,
-  type AgentProfileCreateParams,
-  type AgentProfileUpdateParams,
-  type AgentProfileListParams,
-} from './agent-profiles';
-export {
-  BrowserProfiles,
-  type BrowserProfileView,
-  type ProxyCountryCode,
-  type BrowserProfileListResponse,
-  type BrowserProfileCreateParams,
-  type BrowserProfileUpdateParams,
-  type BrowserProfileListParams,
-} from './browser-profiles';
-export {
-  Sessions,
-  type SessionStatus,
-  type SessionView,
-  type SessionListResponse,
-  type SessionUpdateParams,
-  type SessionListParams,
-} from './sessions/sessions';
-export {
-  Tasks,
-  type FileView,
-  type TaskItemView,
-  type TaskStatus,
-  type TaskStepView,
-  type TaskView,
-  type TaskCreateResponse,
-  type TaskListResponse,
-  type TaskGetLogsResponse,
-  type TaskGetOutputFileResponse,
-  type TaskGetUserUploadedFileResponse,
-  type TaskCreateParams,
-  type TaskUpdateParams,
-  type TaskListParams,
-  type TaskGetOutputFileParams,
-  type TaskGetUserUploadedFileParams,
-} from './tasks';
-export { Users } from './users/users';

package/src/resources/sessions/index.ts

@@ -1,11 +0,0 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-export { PublicShare, type ShareView } from './public-share';
-export {
-  Sessions,
-  type SessionStatus,
-  type SessionView,
-  type SessionListResponse,
-  type SessionUpdateParams,
-  type SessionListParams,
-} from './sessions';

package/src/resources/sessions/public-share.ts

@@ -1,109 +0,0 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-import { APIResource } from '../../core/resource';
-import { APIPromise } from '../../core/api-promise';
-import { buildHeaders } from '../../internal/headers';
-import { RequestOptions } from '../../internal/request-options';
-import { path } from '../../internal/utils/path';
-
-export class PublicShare extends APIResource {
-  /**
-   * Create a public share for a session.
-   *
-   * Generates a public sharing link that allows anyone with the URL to view the
-   * session and its tasks. If a public share already exists for the session, it will
-   * return the existing share instead of creating a new one.
-   *
-   * Public shares are useful for:
-   *
-   * - Sharing results with clients or team members
-   * - Demonstrating AI agent capabilities
-   * - Collaborative review of automated tasks
-   *
-   * Args:
-   *
-   * - session_id: The unique identifier of the agent session to share
-   *
-   * Returns:
-   *
-   * - Public share information including the share URL and usage statistics
-   *
-   * Raises:
-   *
-   * - 404: If the user agent session doesn't exist
-   */
-  create(sessionID: string, options?: RequestOptions): APIPromise<ShareView> {
-    return this._client.post(path`/sessions/${sessionID}/public-share`, options);
-  }
-
-  /**
-   * Get information about the public share for a session.
-   *
-   * Retrieves details about the public sharing link for a session, including the
-   * share token, public URL, view count, and last viewed timestamp. This is useful
-   * for monitoring how your shared sessions are being accessed.
-   *
-   * Args:
-   *
-   * - session_id: The unique identifier of the agent session
-   *
-   * Returns:
-   *
-   * - Public share information including the share URL and usage statistics
-   *
-   * Raises:
-   *
-   * - 404: If the user agent session doesn't exist or doesn't have a public share
-   */
-  retrieve(sessionID: string, options?: RequestOptions): APIPromise<ShareView> {
-    return this._client.get(path`/sessions/${sessionID}/public-share`, options);
-  }
-
-  /**
-   * Remove the public share for a session.
-   *
-   * Deletes the public sharing link for a session, making it no longer accessible to
-   * anyone with the previous share URL. This is useful for removing access to
-   * sensitive sessions or when you no longer want to share the results.
-   *
-   * Args:
-   *
-   * - session_id: The unique identifier of the agent session
-   *
-   * Returns:
-   *
-   * - 204 No Content on successful deletion (idempotent)
-   *
-   * Raises:
-   *
-   * - 404: If the user agent session doesn't exist
-   */
-  delete(sessionID: string, options?: RequestOptions): APIPromise<void> {
-    return this._client.delete(path`/sessions/${sessionID}/public-share`, {
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
-  }
-}
-
-/**
- * View model for representing a public share of a session.
- *
- * Attributes: share_token: Token to access the public share. share_url: URL to
- * access the public share. view_count: Number of times the public share has been
- * viewed. last_viewed_at: Timestamp of the last time the public share was viewed
- * (None if never viewed).
- */
-export interface ShareView {
-  shareToken: string;
-
-  shareUrl: string;
-
-  viewCount: number;
-
-  lastViewedAt?: string | null;
-}
-
-export declare namespace PublicShare {
-  export { type ShareView as ShareView };
-}