browser-use-sdk 0.1.0

package/src/resources/agent-profiles.ts

@@ -0,0 +1,163 @@
+// 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 { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class AgentProfiles extends APIResource {
+  /**
+   * Create Agent Profile
+   */
+  create(body: AgentProfileCreateParams, options?: RequestOptions): APIPromise<AgentProfileView> {
+    return this._client.post('/agent-profiles', { body, ...options });
+  }
+
+  /**
+   * Get Agent Profile
+   */
+  retrieve(profileID: string, options?: RequestOptions): APIPromise<AgentProfileView> {
+    return this._client.get(path`/agent-profiles/${profileID}`, options);
+  }
+
+  /**
+   * Update Agent Profile
+   */
+  update(
+    profileID: string,
+    body: AgentProfileUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<AgentProfileView> {
+    return this._client.patch(path`/agent-profiles/${profileID}`, { body, ...options });
+  }
+
+  /**
+   * List Agent Profiles
+   */
+  list(
+    query: AgentProfileListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<AgentProfileListResponse> {
+    return this._client.get('/agent-profiles', { query, ...options });
+  }
+
+  /**
+   * Delete Agent Profile
+   */
+  delete(profileID: string, options?: RequestOptions): APIPromise<unknown> {
+    return this._client.delete(path`/agent-profiles/${profileID}`, options);
+  }
+}
+
+/**
+ * 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 system_prompt: Custom system prompt for
+ * the agent (optionally set by the user) 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;
+
+  description: string;
+
+  flashMode: boolean;
+
+  highlightElements: boolean;
+
+  maxAgentSteps: number;
+
+  name: string;
+
+  systemPrompt: 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 type AgentProfileDeleteResponse = unknown;
+
+export interface AgentProfileCreateParams {
+  name: string;
+
+  allowedDomains?: Array<string>;
+
+  description?: string;
+
+  flashMode?: boolean;
+
+  highlightElements?: boolean;
+
+  maxAgentSteps?: number;
+
+  systemPrompt?: string;
+
+  thinking?: boolean;
+
+  vision?: boolean;
+}
+
+export interface AgentProfileUpdateParams {
+  allowedDomains?: Array<string> | null;
+
+  description?: string | null;
+
+  flashMode?: boolean | null;
+
+  highlightElements?: boolean | null;
+
+  maxAgentSteps?: number | null;
+
+  name?: string | null;
+
+  systemPrompt?: 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 AgentProfileDeleteResponse as AgentProfileDeleteResponse,
+    type AgentProfileCreateParams as AgentProfileCreateParams,
+    type AgentProfileUpdateParams as AgentProfileUpdateParams,
+    type AgentProfileListParams as AgentProfileListParams,
+  };
+}

package/src/resources/browser-profiles.ts

@@ -0,0 +1,172 @@
+// 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 { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class BrowserProfiles extends APIResource {
+  /**
+   * Create Browser Profile
+   */
+  create(body: BrowserProfileCreateParams, options?: RequestOptions): APIPromise<BrowserProfileView> {
+    return this._client.post('/browser-profiles', { body, ...options });
+  }
+
+  /**
+   * Get Browser Profile
+   */
+  retrieve(profileID: string, options?: RequestOptions): APIPromise<BrowserProfileView> {
+    return this._client.get(path`/browser-profiles/${profileID}`, options);
+  }
+
+  /**
+   * Update Browser Profile
+   */
+  update(
+    profileID: string,
+    body: BrowserProfileUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<BrowserProfileView> {
+    return this._client.patch(path`/browser-profiles/${profileID}`, { body, ...options });
+  }
+
+  /**
+   * List Browser Profiles
+   */
+  list(
+    query: BrowserProfileListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<BrowserProfileListResponse> {
+    return this._client.get('/browser-profiles', { query, ...options });
+  }
+
+  /**
+   * Delete Browser Profile
+   */
+  delete(profileID: string, options?: RequestOptions): APIPromise<unknown> {
+    return this._client.delete(path`/browser-profiles/${profileID}`, options);
+  }
+}
+
+/**
+ * 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 is 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 type BrowserProfileDeleteResponse = unknown;
+
+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 BrowserProfileDeleteResponse as BrowserProfileDeleteResponse,
+    type BrowserProfileCreateParams as BrowserProfileCreateParams,
+    type BrowserProfileUpdateParams as BrowserProfileUpdateParams,
+    type BrowserProfileListParams as BrowserProfileListParams,
+  };
+}

package/src/resources/index.ts

@@ -0,0 +1,45 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  AgentProfiles,
+  type AgentProfileView,
+  type AgentProfileListResponse,
+  type AgentProfileDeleteResponse,
+  type AgentProfileCreateParams,
+  type AgentProfileUpdateParams,
+  type AgentProfileListParams,
+} from './agent-profiles';
+export {
+  BrowserProfiles,
+  type BrowserProfileView,
+  type ProxyCountryCode,
+  type BrowserProfileListResponse,
+  type BrowserProfileDeleteResponse,
+  type BrowserProfileCreateParams,
+  type BrowserProfileUpdateParams,
+  type BrowserProfileListParams,
+} from './browser-profiles';
+export {
+  Sessions,
+  type SessionStatus,
+  type SessionView,
+  type SessionListResponse,
+  type SessionRetrieveParams,
+  type SessionUpdateParams,
+  type SessionListParams,
+} from './sessions/sessions';
+export {
+  Tasks,
+  type LlmModel,
+  type TaskStatus,
+  type TaskView,
+  type TaskRetrieveResponse,
+  type TaskListResponse,
+  type TaskRetrieveLogsResponse,
+  type TaskRetrieveOutputFileResponse,
+  type TaskCreateParams,
+  type TaskRetrieveParams,
+  type TaskUpdateParams,
+  type TaskListParams,
+  type TaskRetrieveOutputFileParams,
+} from './tasks';

package/src/resources/sessions/index.ts

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

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

@@ -0,0 +1,53 @@
+// 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 { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class PublicShare extends APIResource {
+  /**
+   * Create Session Public Share
+   */
+  create(sessionID: string, options?: RequestOptions): APIPromise<ShareView> {
+    return this._client.post(path`/sessions/${sessionID}/public-share`, options);
+  }
+
+  /**
+   * Get Session Public Share
+   */
+  retrieve(sessionID: string, options?: RequestOptions): APIPromise<ShareView> {
+    return this._client.get(path`/sessions/${sessionID}/public-share`, options);
+  }
+
+  /**
+   * Delete Session Public Share
+   */
+  delete(sessionID: string, options?: RequestOptions): APIPromise<unknown> {
+    return this._client.delete(path`/sessions/${sessionID}/public-share`, options);
+  }
+}
+
+/**
+ * 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 type PublicShareDeleteResponse = unknown;
+
+export declare namespace PublicShare {
+  export { type ShareView as ShareView, type PublicShareDeleteResponse as PublicShareDeleteResponse };
+}

package/src/resources/sessions/sessions.ts

@@ -0,0 +1,150 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as TasksAPI from '../tasks';
+import * as PublicShareAPI from './public-share';
+import { PublicShare, PublicShareDeleteResponse, ShareView } from './public-share';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Sessions extends APIResource {
+  publicShare: PublicShareAPI.PublicShare = new PublicShareAPI.PublicShare(this._client);
+
+  /**
+   * Get Session
+   */
+  retrieve(
+    sessionID: string,
+    query: SessionRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<SessionView> {
+    return this._client.get(path`/sessions/${sessionID}`, { query, ...options });
+  }
+
+  /**
+   * Update Session
+   */
+  update(sessionID: string, body: SessionUpdateParams, options?: RequestOptions): APIPromise<SessionView> {
+    return this._client.patch(path`/sessions/${sessionID}`, { body, ...options });
+  }
+
+  /**
+   * List Sessions
+   */
+  list(
+    query: SessionListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<SessionListResponse> {
+    return this._client.get('/sessions', { query, ...options });
+  }
+}
+
+/**
+ * Enumeration of possible (browser) session states
+ *
+ * Attributes: ACTIVE: Session is currently active and running (aka browser is
+ * running) STOPPED: Session has been stopped and is no longer active (aka browser
+ * is stopped)
+ */
+export type SessionStatus = 'active' | 'stopped';
+
+/**
+ * View model for representing a (browser) session with its associated tasks.
+ *
+ * Attributes: id: Unique identifier for the session. status: Current status of the
+ * session (active/stopped). live_url: URL where the browser can be viewed live in
+ * real-time. record_url: URL to access the recorded session playback. started_at:
+ * Timestamp when the session was created and started. finished_at: Timestamp when
+ * the session was stopped (None if still active). tasks: List of tasks associated
+ * with this session (optional). public_share_url: URL to access the public share
+ * of the session (optional).
+ */
+export interface SessionView {
+  id: string;
+
+  startedAt: string;
+
+  /**
+   * Enumeration of possible (browser) session states
+   *
+   * Attributes: ACTIVE: Session is currently active and running (aka browser is
+   * running) STOPPED: Session has been stopped and is no longer active (aka browser
+   * is stopped)
+   */
+  status: SessionStatus;
+
+  finishedAt?: string | null;
+
+  liveUrl?: string | null;
+
+  publicShareUrl?: string | null;
+
+  recordUrl?: string | null;
+
+  tasks?: Array<TasksAPI.TaskView> | null;
+}
+
+/**
+ * Response model for paginated session list requests
+ *
+ * Attributes: items: List of session views for the current page
+ */
+export interface SessionListResponse {
+  items: Array<SessionView>;
+
+  pageNumber: number;
+
+  pageSize: number;
+
+  totalItems: number;
+}
+
+export interface SessionRetrieveParams {
+  includeTasks?: boolean;
+}
+
+export interface SessionUpdateParams {
+  /**
+   * Available actions that can be performed on a session
+   *
+   * Attributes: STOP: Stop the session and all its associated tasks
+   */
+  action: 'stop';
+}
+
+export interface SessionListParams {
+  /**
+   * Enumeration of possible (browser) session states
+   *
+   * Attributes: ACTIVE: Session is currently active and running (aka browser is
+   * running) STOPPED: Session has been stopped and is no longer active (aka browser
+   * is stopped)
+   */
+  filterBy?: SessionStatus | null;
+
+  includeTasks?: boolean;
+
+  pageNumber?: number;
+
+  pageSize?: number;
+}
+
+Sessions.PublicShare = PublicShare;
+
+export declare namespace Sessions {
+  export {
+    type SessionStatus as SessionStatus,
+    type SessionView as SessionView,
+    type SessionListResponse as SessionListResponse,
+    type SessionRetrieveParams as SessionRetrieveParams,
+    type SessionUpdateParams as SessionUpdateParams,
+    type SessionListParams as SessionListParams,
+  };
+
+  export {
+    PublicShare as PublicShare,
+    type ShareView as ShareView,
+    type PublicShareDeleteResponse as PublicShareDeleteResponse,
+  };
+}

package/src/resources/sessions.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './sessions/index';