@airtop/sdk 0.1.35-beta0 → 1.0.0-alpha2.0

package/dist/index.d.cts

@@ -0,0 +1,1028 @@
+import * as _airtop_core from '@airtop/core';
+import { Airtop } from '@airtop/core';
+import { AirtopJsonSchemaAdapter } from '@airtop/json-schema-adapter';
+export { AirtopJsonSchemaAdapter } from '@airtop/json-schema-adapter';
+import { ILogLayer } from 'loglayer';
+export { ILogLayer } from 'loglayer';
+import * as _airtop_core_resources_shared_mjs from '@airtop/core/resources/shared.mjs';
+import { AutomationUpdateDescriptionParams } from '@airtop/core/resources/automations.js';
+import { SessionListParams, ProfileOutput, FileListParams, FilesResponse, FileCreateFileParams, WindowIDData, EnvelopeDefaultMeta as EnvelopeDefaultMeta$1, Issue as Issue$1, WindowInfo, WindowGetParams, AIPromptResponse, ScrapeResponse } from '@airtop/core/resources/index.js';
+import * as _airtop_core_resources_shared_js from '@airtop/core/resources/shared.js';
+import { SessionConfigV1, GetFileResponse, ListAutomationsOutput, AutomationData, ExternalSessionWithConnectionInfo, EnvelopeDefaultMeta, Issue, AIPromptResponse as AIPromptResponse$1, WindowIDDataResponse, OperationOutcomeResponse } from '@airtop/core/resources/shared.js';
+export { AIResponseEnvelope, AirtopPagination, ExternalSessionAIResponseMetadata, ExternalSessionWithConnectionInfo, Issue, OperationOutcomeResponse, WindowIDDataResponse } from '@airtop/core/resources/shared.js';
+import * as _airtop_core_resources_sessions_mjs from '@airtop/core/resources/sessions.mjs';
+import { WindowClickParams, WindowHoverParams, WindowLoadURLParams, WindowMonitorParams, WindowScrapeParams, WindowScreenshotParams, WindowScrollParams, WindowTypeParams } from '@airtop/core/resources/windows.js';
+
+/**
+ * Shared configuration between Airtop classes.
+ */
+interface CommonAirtopConfig {
+    /**
+     * The Airtop Core SDK client instance for making API calls.
+     */
+    client: Airtop;
+    /**
+     * LogLayer logger instance for recording events and debugging information.
+     * @see {@link https://loglayer.dev | LogLayer Documentation}
+     */
+    log: ILogLayer;
+    /**
+     * The log level to use for logging operations.
+     * Defaults to "error" if not specified.
+     */
+    logLevel?: "debug" | "off" | "error" | "warn" | "info";
+    /**
+     * Optional adapter for converting between different JSON schema formats.
+     * Used for customizing output schema handling.
+     */
+    outputSchemaAdapter?: AirtopJsonSchemaAdapter;
+}
+/**
+ * Configuration for defining the JSON schema output.
+ */
+interface OutputJsonSchemaConfig {
+    configuration: {
+        /**
+         * JSON schema defining the structure of the output.
+         */
+        outputSchema?: any;
+    };
+}
+/**
+ * Common options for making requests to the Airtop API.
+ * Controls request behavior and timeout settings.
+ */
+interface AirtopRequestOptions {
+    /**
+     * Maximum time in seconds to wait for a response.
+     */
+    timeoutInSeconds?: number;
+    /**
+     * Maximum number of retry attempts for failed requests.
+     */
+    maxRetries?: number;
+    /**
+     * Signal for aborting the request.
+     */
+    abortSignal?: AbortSignal;
+}
+/**
+ * Format for responses from the Airtop API
+ */
+interface CommonResponse {
+    data: unknown;
+    meta: unknown;
+    warnings?: unknown;
+    errors?: unknown;
+}
+
+/**
+ * Base class for Airtop SDK implementation
+ * Provides common functionality for JSON schema conversion, error handling, and request configuration
+ * @hidden
+ */
+declare class AirtopBase {
+    /**
+     * Logger instance for the SDK
+     * @internal
+     **/
+    protected log: ILogLayer;
+    /**
+     * Airtop Core SDK client instance
+     * @internal
+     **/
+    protected client: Airtop;
+    /**
+     * JSON schema adapter for output conversion
+     * @internal
+     **/
+    protected outputJsonAdapter: AirtopJsonSchemaAdapter;
+    /**
+     * Creates a new instance of AirtopBase
+     * @param config - Configuration options for the SDK
+     */
+    constructor(config: CommonAirtopConfig);
+    /**
+     * Returns the API key used by the SDK
+     * @returns API key string
+     */
+    getApiKey(): string;
+    /**
+     * Sets the base URL for the Airtop API.
+     * @param airtopUrl - The base URL for the Airtop API
+     */
+    setAirtopUrl(airtopUrl: string): void;
+    /**
+     * Sets the API key for authentication.
+     * @param apiKey - The API key to use for authentication
+     */
+    setApiKey(apiKey: string): void;
+    /**
+     * Returns the LogLayer logger instance used by the SDK
+     * @returns Logger instance
+     * @see {@link https://loglayer.dev | LogLayer Documentation}
+     */
+    getLogger(): ILogLayer;
+    /**
+     * Converts input data to JSON schema format
+     * @param input - Data to be converted (schema input, string, or object)
+     * @returns JSON string representation of the input
+     * @internal
+     */
+    protected convertToJsonSchema(input?: any): string;
+    /**
+     * Returns the common configuration used by the SDK
+     * @returns Common configuration object
+     * @internal
+     */
+    protected getCommonConfig(): CommonAirtopConfig;
+    /**
+     * Translates the request options to ones used by the Core SDK
+     * @param options - Request options to be resolved
+     * @returns Resolved request options with defaults
+     * @internal
+     */
+    protected resolveRequestOptions(options?: AirtopRequestOptions): {
+        timeout: number;
+        maxRetries: number;
+        signal: AbortSignal;
+    };
+}
+
+/**
+ * Configuration options for creating a new Airtop SDK instance.
+ * Controls authentication, logging, and schema handling.
+ */
+interface AirtopConstructorConfig {
+    /**
+     * The API key to use for authentication with the Airtop API.
+     * Required for all API operations.
+     */
+    apiKey: string;
+    /**
+     * The base URL for the Airtop API.
+     * Defaults to https://api.airtop.ai/api/v1 if not specified.
+     */
+    airtopUrl?: string;
+    /**
+     * Custom logger instance to use for logging operations.
+     * If not provided, defaults to console logging.
+     */
+    logger?: ILogLayer;
+    /**
+     * The log level to use for logging operations.
+     * Controls the verbosity of log output.
+     * Defaults to "off" if not specified.
+     */
+    logLevel?: "debug" | "off" | "error" | "warn" | "info";
+    /**
+     * JSON schema adapter to convert output schema definitions.
+     * Used to customize how response data is structured.
+     */
+    outputSchemaAdapter?: AirtopJsonSchemaAdapter;
+}
+/**
+ * Configuration options for creating a new session.
+ */
+interface CreateSessionConfig extends SessionConfigV1 {
+    /**
+     * Whether to skip waiting for the session to be ready.
+     * If true, returns immediately after session creation.
+     * If false (default), waits for the session to be fully initialized.
+     */
+    skipWaitSessionReady?: boolean;
+}
+/**
+ * Configuration options for retrieving multiple sessions.
+ * Excludes session IDs which are provided separately.
+ */
+interface GetSessionsConfig extends Omit<SessionListParams, "sessionIds"> {
+}
+/**
+ * Configuration options for retrieving multiple files.
+ * Excludes session IDs which are provided separately.
+ */
+interface GetFilesConfig extends Omit<FileListParams, "sessionIds"> {
+}
+interface AirtopFileResponse extends GetFileResponse {
+}
+interface AirtopFilesListResponse extends FilesResponse {
+}
+interface AirtopAutomationUpdateDescriptionConfig extends AutomationUpdateDescriptionParams {
+}
+interface AirtopAutomationData extends AutomationData {
+}
+interface AirtopAutomationListResponse extends ListAutomationsOutput {
+}
+interface AirtopProfile extends ProfileOutput {
+}
+
+/**
+ * The session data containing connection and state information.
+ * Includes details about the browser session and its configuration.
+ */
+interface SessionData extends ExternalSessionWithConnectionInfo {
+}
+/**
+ * The metadata associated with the session.
+ * Contains information about the request that created the session.
+ */
+interface SessionMetadata extends EnvelopeDefaultMeta {
+}
+/**
+ * A warning that occurred during session creation or operation.
+ * A non-fatal issue that didn't prevent session creation.
+ */
+interface SessionWarning extends Issue {
+}
+/**
+ * An error that occurred during session creation or operation.
+ * This is a fatal issue that prevented session creation.
+ */
+interface SessionError extends Issue {
+}
+/**
+ * Data structure for initializing an Airtop browser session.
+ * Contains all necessary information about a session's state and configuration.
+ */
+interface AirtopSessionResponse {
+    /**
+     * The session data containing connection and state information.
+     * Includes details about the browser session and its configuration.
+     */
+    data: SessionData;
+    /**
+     * The metadata associated with the session.
+     * Contains information about the request that created the session.
+     */
+    meta?: SessionMetadata;
+    /**
+     * Warnings that occurred during session creation or operation.
+     * These are non-fatal issues that didn't prevent session creation.
+     */
+    warnings?: SessionWarning[];
+    /**
+     * Errors that occurred during session creation or operation.
+     * These are fatal issues that prevented session creation.
+     */
+    errors?: SessionError[];
+}
+/**
+ * Configuration parameters for retrieving a window.
+ * Excludes session ID which is provided by the parent session.
+ */
+interface CreateFileConfig extends Omit<FileCreateFileParams, "sessionId" | "fileName"> {
+}
+
+/**
+ * Common data found in a window API call response.
+ */
+interface CommonWindowResponse extends CommonResponse {
+    data: {
+        /**
+         * The ID of the window.
+         */
+        windowId: string;
+    };
+}
+/**
+ * The window data from creating a new window.
+ */
+interface WindowCreateData extends WindowIDData {
+}
+/**
+ * The window data from fetching window information.
+ */
+interface WindowInfoData extends WindowInfo {
+}
+/**
+ * The metadata associated with the window.
+ * Contains information about the request that created the window.
+ */
+interface WindowMetadata extends EnvelopeDefaultMeta$1 {
+}
+/**
+ * A warning associated with the creation of the window.
+ * A non-fatal issue that didn't prevent session creation.
+ */
+interface WindowWarning extends Issue$1 {
+}
+/**
+ * An error that occurred during session creation or operation.
+ * This is a fatal issue that prevented session creation.
+ */
+interface WindowError extends Issue$1 {
+}
+/**
+ * Response object for creating a new window.
+ */
+interface AirtopWindowCreateResponse {
+    /**
+     * The window data containing window-specific information.
+     */
+    data: WindowCreateData;
+    /**
+     * The metadata associated with the window.
+     */
+    meta: WindowMetadata;
+    /**
+     * Warnings associated with the creation of the window.
+     * These are non-fatal issues that occurred during window creation.
+     */
+    warnings?: WindowWarning[];
+    /**
+     * Errors that occurred during window creation or operation.
+     * These are fatal issues that prevented window creation.
+     */
+    errors?: WindowError[];
+}
+/**
+ * Response object for getting window information.
+ */
+interface AirtopWindowGetInfoResponse extends AirtopWindowCreateResponse {
+    /**
+     * The window data containing window-specific information.
+     */
+    data: WindowInfoData;
+}
+
+/**
+ * Configuration parameters for typing text in a window.
+ * Excludes session ID and text content which are provided separately.
+ */
+interface WindowTypeConfig extends Omit<WindowTypeParams, "sessionId" | "text"> {
+}
+/**
+ * Configuration parameters for retrieving a window.
+ * Excludes session ID which is provided by the parent session.
+ */
+interface WindowGetConfig extends Omit<WindowGetParams, "sessionId"> {
+}
+/**
+ * Configuration parameters for clicking on an element in a window.
+ * Includes all click-related parameters from the core API.
+ */
+interface WindowClickConfig extends WindowClickParams {
+}
+/**
+ * Configuration parameters for hovering over an element in a window.
+ * Excludes session ID which is provided by the parent session.
+ */
+interface WindowHoverConfig extends Omit<WindowHoverParams, "sessionId"> {
+}
+/**
+ * Configuration parameters for loading a URL in a window.
+ * Excludes session ID and URL which are provided separately.
+ */
+interface WindowLoadUrlConfig extends Omit<WindowLoadURLParams, "sessionId" | "url"> {
+}
+/**
+ * Configuration parameters for monitoring window events.
+ * Excludes session ID which is provided by the parent session.
+ */
+interface WindowMonitorConfig extends Omit<WindowMonitorParams, "sessionId"> {
+}
+/**
+ * Configuration parameters for performing a natural language query on page content.
+ */
+interface WindowPageQueryConfig extends OutputJsonSchemaConfig {
+}
+/**
+ * Configuration parameters for extracting paginated data from a window.
+ */
+interface WindowPaginatedExtractionConfig extends OutputJsonSchemaConfig {
+}
+/**
+ * Configuration parameters for scraping content from a window.
+ * Excludes session ID which is provided by the parent session.
+ */
+interface WindowScrapeConfig extends Omit<WindowScrapeParams, "sessionId"> {
+}
+/**
+ * Configuration parameters for taking a screenshot of a window.
+ * Excludes session ID which is provided by the parent session.
+ */
+interface WindowScreenshotConfig extends Omit<WindowScreenshotParams, "sessionId"> {
+}
+/**
+ * Configuration parameters for scrolling a window.
+ * Excludes session ID which is provided by the parent session.
+ */
+interface WindowScrollConfig extends Omit<WindowScrollParams, "sessionId"> {
+}
+/**
+ * Response for calls that involve an AI prompt.
+ */
+interface WindowPromptResponse extends AIPromptResponse {
+}
+/**
+ * Scrape window response.
+ */
+interface WindowScrapeResponse extends ScrapeResponse {
+}
+
+/**
+ * Response object for a screenshot operation.
+ */
+interface AirtopWindowScreenshotResponse extends AIPromptResponse$1 {
+}
+/**
+ * Contains the data for a screenshot operation.
+ */
+interface ScreenshotData {
+    index: number;
+    success: boolean;
+    binaryData?: Buffer;
+    mimeType?: string;
+    error?: Error;
+}
+
+/**
+ * The result of a screenshot operation.
+ */
+declare class AirtopWindowScreenshot {
+    data: AirtopWindowScreenshotResponse["data"];
+    meta: AirtopWindowScreenshotResponse["meta"];
+    warnings: AirtopWindowScreenshotResponse["warnings"];
+    errors: AirtopWindowScreenshotResponse["errors"];
+    /**
+     * Creates a new AirtopWindowScreenshot instance.
+     * @param screenshotData - Initial screenshot data and configuration
+     */
+    constructor(screenshotData: AirtopWindowScreenshotResponse);
+    /**
+     * Processes the screenshots and returns them as JPG images.
+     */
+    screenshotsAsJpg(): ScreenshotData[];
+    /**
+     * Returns response data as a JSON object.
+     */
+    toJSON(): {
+        data: _airtop_core_resources_shared_js.AIResponseEnvelope;
+        meta: _airtop_core_resources_shared_js.ExternalSessionAIResponseMetadata;
+        warnings: _airtop_core_resources_shared_js.Issue[];
+        errors: _airtop_core_resources_shared_js.Issue[];
+    };
+}
+
+/**
+ * Client for making window-specific requests to the Airtop API.
+ */
+declare class AirtopWindowClient extends AirtopBase {
+    /**
+     * The browser session id
+     * @internal
+     */
+    protected sessionId: string;
+    /**
+     * The window id
+     * @internal
+     */
+    protected windowId: string;
+    /**
+     * Creates a new AirtopWindow instance.
+     * @param config - Common configuration options for the window
+     * @param sessionId - Browser session id
+     * @param windowId - Browser window id
+     */
+    constructor(config: CommonAirtopConfig, sessionId: string, windowId: string);
+    /**
+     * Gets the window ID.
+     */
+    getWindowId(): string;
+    /**
+     * Gets the browser session id associated with the window.
+     */
+    getSessionId(): string;
+    /**
+     * Retrieves a window from a specific session.
+     * @param config - Configuration options for the window
+     * @param requestOptions - Request options
+     * @returns AirtopWindow<AirtopWindowGetInfoResponse> instance
+     */
+    getWindowInfo(config?: WindowGetConfig, requestOptions?: AirtopRequestOptions): Promise<AirtopWindow<AirtopWindowGetInfoResponse>>;
+    /**
+     * Simulates a click on an element in the window.
+     * @param elementDescription - Description or selector of the element to click
+     * @param config - Additional configuration options for the click action
+     * @param requestOptions - Request options
+     * @returns Promise resolving to the click operation result
+     */
+    click(elementDescription: string, config?: WindowClickConfig, requestOptions?: AirtopRequestOptions): Promise<WindowPromptResponse>;
+    /**
+     * Closes the window.
+     * @returns Promise resolving when the window is closed
+     */
+    close(): Promise<WindowIDDataResponse>;
+    /**
+     * Simulates hovering over an element in the window.
+     * @param elementDescription - Description or selector of the element to hover over
+     * @param config - Additional configuration options for the hover action
+     * @param requestOptions - Request options
+     * @returns Promise resolving to the hover operation result
+     */
+    hover(elementDescription: string, config?: WindowHoverConfig, requestOptions?: AirtopRequestOptions): Promise<WindowPromptResponse>;
+    /**
+     * Loads a URL in the window.
+     * @param url - The URL to load
+     * @param config - Additional configuration options for loading the URL
+     * @param requestOptions - Request options
+     * @returns Promise resolving when the URL is loaded
+     */
+    loadUrl(url: string, config?: WindowLoadUrlConfig, requestOptions?: AirtopRequestOptions): Promise<OperationOutcomeResponse>;
+    /**
+     * Monitors the window for changes or events.
+     * @param condition - A natural language description of the condition to monitor for in the browser window
+     * @param config - Configuration options for monitoring
+     * @param requestOptions - Request options
+     * @returns Promise resolving to the monitoring operation result
+     */
+    monitor(condition: string, config?: WindowMonitorConfig, requestOptions?: AirtopRequestOptions): Promise<WindowPromptResponse>;
+    /**
+     * Performs a natural language query on the page content.
+     * @param prompt - The natural language query prompt
+     * @param config - Configuration options for the query
+     * @param requestOptions - Request options
+     * @returns Promise resolving to the query results
+     */
+    pageQuery(prompt: string, config?: WindowPageQueryConfig, requestOptions?: AirtopRequestOptions): Promise<WindowPromptResponse>;
+    /**
+     * Performs paginated data extraction from the window content.
+     * @param prompt - The extraction prompt
+     * @param config - Configuration options for the extraction
+     * @param requestOptions - Request options
+     * @returns Promise resolving to the extracted data
+     */
+    paginatedExtraction(prompt: string, config?: WindowPaginatedExtractionConfig, requestOptions?: AirtopRequestOptions): Promise<WindowPromptResponse>;
+    /**
+     * Scrapes content from the window.
+     * @param config - Configuration options for scraping
+     * @param requestOptions - Request options
+     * @returns Promise resolving to the scraped content
+     */
+    scrape(config?: WindowScrapeConfig, requestOptions?: AirtopRequestOptions): Promise<WindowScrapeResponse>;
+    /**
+     * Takes a screenshot of the window.
+     * @param config - Configuration options for the screenshot
+     * @param requestOptions - Request options
+     * @returns Promise resolving to the screenshot data
+     */
+    screenshot(config?: WindowScreenshotConfig, requestOptions?: AirtopRequestOptions): Promise<AirtopWindowScreenshot>;
+    /**
+     * Scrolls the window content.
+     * @param config - Configuration options for scrolling
+     * @param requestOptions - Request options
+     * @returns Promise resolving when the scroll operation is complete
+     */
+    scroll(config?: WindowScrollConfig, requestOptions?: AirtopRequestOptions): Promise<WindowPromptResponse>;
+    /**
+     * Types text into the window.
+     * @param text - The text to type
+     * @param config - Configuration options for typing
+     * @param requestOptions - Request options
+     * @returns Promise resolving when the text has been typed
+     */
+    type(text: string, config?: WindowTypeConfig, requestOptions?: AirtopRequestOptions): Promise<_airtop_core_resources_shared_mjs.AIPromptResponse>;
+}
+
+/**
+ * Represents a browser window in a browser session.
+ */
+declare class AirtopWindow<Response extends CommonWindowResponse> extends AirtopWindowClient {
+    /**
+     * The window data containing window-specific information.
+     */
+    data: Response["data"];
+    /**
+     * The metadata associated with the window.
+     */
+    meta: Response["meta"];
+    /**
+     * Warnings associated with the creation of the window.
+     * These are non-fatal issues that occurred during window creation.
+     */
+    warnings: Response["warnings"];
+    /**
+     * Errors that occurred during window creation or operation.
+     * These are fatal issues that prevented window creation.
+     */
+    errors: Response["errors"];
+    /**
+     * Creates a new AirtopWindow instance.
+     * @param config - Common configuration options for the window
+     * @param sessionId - Browser session id
+     * @param windowData - Initial window data and configuration
+     */
+    constructor(config: CommonAirtopConfig, sessionId: string, windowData: Response);
+    /**
+     * Returns response data as a JSON object.
+     */
+    toJSON(): {
+        data: Response["data"];
+        meta: Response["meta"];
+        warnings: Response["warnings"];
+        errors: Response["errors"];
+    };
+}
+
+/**
+ * Client for making session-specific requests to the Airtop API.
+ */
+declare class AirtopSessionClient extends AirtopBase {
+    /**
+     * The browser session id
+     * @internal
+     */
+    protected sessionId: string;
+    /**
+     * Creates a new AirtopSession instance.
+     * @param config - Common configuration options for the session
+     * @param sessionId - Browser session id
+     */
+    constructor(config: CommonAirtopConfig, sessionId: string);
+    /**
+     * Returns the browser session ID.
+     */
+    getSessionId(): string;
+    /**
+     * Gets the state of the session using the attached session id.
+     * @param requestOptions - Request options
+     * @returns AirtopSession instance or null if not found
+     */
+    getSessionInfo(requestOptions?: AirtopRequestOptions): Promise<AirtopSession>;
+    /**
+     * Configures the session to save a profile when it terminates.
+     * @param profileName - Name of the profile to save
+     * @param requestOptions - Request options
+     */
+    saveProfileOnTermination(profileName: string, requestOptions?: AirtopRequestOptions): Promise<void>;
+    /**
+     * Waits for the session to be in a ready state.
+     * @returns The event indicating the session is ready
+     */
+    waitForSessionReady(): Promise<_airtop_core_resources_sessions_mjs.SessionGetEventsResponse>;
+    /**
+     * Terminates the current session.
+     * If the session is already terminated, this method will log a message and return.
+     */
+    terminateSession(): Promise<void>;
+    /**
+     * Creates a new window in the current session.
+     * @param url - The URL to load in the new window
+     * @param requestOptions - Request options
+     * @returns A new AirtopWindow<AirtopWindowCreateResponse> instance
+     */
+    createWindow(url: string, requestOptions?: AirtopRequestOptions): Promise<AirtopWindow<AirtopWindowCreateResponse>>;
+    /**
+     * Returns a window client instance for making window-based requests for a given window id.
+     *
+     * @param windowId - The session ID to attach to the AirtopWindowClient instance
+     **/
+    withWindowId(windowId: string): AirtopWindowClient;
+    /**
+     * Creates a new file in the current session.
+     * @param fileName - The name of the file to create
+     * @param config - Additional configuration options for creating the file
+     * @param requestOptions - Request options
+     */
+    createFile(fileName: string, config?: CreateFileConfig, requestOptions?: AirtopRequestOptions): _airtop_core.APIPromise<_airtop_core_resources_shared_mjs.CreateFileResponse>;
+}
+
+/**
+ * Represents a browser session.
+ */
+declare class AirtopSession extends AirtopSessionClient {
+    /**
+     * The session data containing connection and state information.
+     * Includes details about the browser session and its configuration.
+     */
+    data: SessionData;
+    /**
+     * The metadata associated with the session.
+     * Contains information about the request that created the session.
+     */
+    meta?: SessionMetadata;
+    /**
+     * Warnings that occurred during session creation or operation.
+     * These are non-fatal issues that didn't prevent session creation.
+     */
+    warnings?: SessionWarning[];
+    /**
+     * Errors that occurred during session creation or operation.
+     * These are fatal issues that prevented session creation.
+     */
+    errors?: SessionError[];
+    /**
+     * Creates a new AirtopSession instance.
+     * @param config - Common configuration options for the session
+     * @param sessionData - Browser session data
+     */
+    constructor(config: CommonAirtopConfig, sessionData: AirtopSessionResponse);
+    /**
+     * Returns response data as a JSON object.
+     */
+    toJSON(): {
+        data: SessionData;
+        meta: SessionMetadata;
+        warnings: SessionWarning[];
+        errors: SessionError[];
+    };
+}
+
+/**
+ * Main Airtop SDK class that provides functionality for managing sessions, profiles, and windows.
+ */
+declare class AirtopClient extends AirtopBase {
+    /**
+     * Creates a new instance of the Airtop SDK.
+     * @param config - Configuration options for the Airtop SDK
+     */
+    constructor(config: AirtopConstructorConfig);
+    /**
+     * Creates a new Airtop session.
+     * @param config - Configuration options for the session
+     * @param options - Request options
+     * @returns A new AirtopSession instance
+     */
+    createSession(config?: CreateSessionConfig, options?: AirtopRequestOptions): Promise<AirtopSession>;
+    /**
+     * Retrieves multiple sessions by their IDs.
+     * @param sessionIds - Array of session IDs to retrieve
+     * @param config - Configuration options for the request
+     * @param requestOptions - Request options
+     * @returns Object containing pagination info and array of AirtopSession instances
+     */
+    getSessions(sessionIds: string[], config?: GetSessionsConfig, requestOptions?: AirtopRequestOptions): Promise<{
+        pagination: _airtop_core_resources_shared_mjs.AirtopPagination;
+        sessions: AirtopSession[];
+        errors: _airtop_core_resources_shared_mjs.Issue[];
+        meta: _airtop_core_resources_shared_mjs.EnvelopeDefaultMeta;
+        warnings: _airtop_core_resources_shared_mjs.Issue[];
+    }>;
+    /**
+     * Removes one or more profiles.
+     * @param profileNames - Name(s) of the profile(s) to remove
+     * @param requestOptions - Request options
+     */
+    removeProfile(profileNames: string[] | string, requestOptions?: AirtopRequestOptions): Promise<void>;
+    /**
+     * Retrieves a profile by name.
+     * @param profileName - Name of the profile to retrieve
+     * @param requestOptions - Request options
+     * @returns The profile
+     */
+    getProfile(profileName: string, requestOptions?: AirtopRequestOptions): Promise<AirtopProfile>;
+    /**
+     * Renames a profile.
+     * @param sourceName - Current name of the profile
+     * @param targetName - New name for the profile
+     * @param requestOptions - Request options
+     */
+    renameProfile(sourceName: string, targetName: string, requestOptions?: AirtopRequestOptions): Promise<void>;
+    /**
+     * Returns a session client instance for making session-based requests for a given session id.
+     *
+     * @param sessionId - The session ID to attach to the AirtopSessionClient instance
+     **/
+    withSessionId(sessionId: string): AirtopSessionClient;
+    /**
+     * Retrieves the status of a request.
+     * @param requestId - ID of the request to check
+     * @param requestOptions - Request options
+     * @returns Status of the request
+     */
+    getRequestStatus(requestId: string, requestOptions?: AirtopRequestOptions): Promise<_airtop_core_resources_shared_mjs.RequestStatusResponse>;
+    /**
+     * Gets a file by ID.
+     * @param fileId
+     * @param requestOptions
+     */
+    getFile(fileId: string, requestOptions?: AirtopRequestOptions): Promise<AirtopFileResponse>;
+    /**
+     * Lists files filtered by session IDs.
+     * @param sessionIds - Array of session IDs to retrieve files for
+     * @param config - Configuration options for the request
+     * @param requestOptions - Request options
+     * @returns Object containing pagination info and array of AirtopSession instances
+     */
+    listFiles(sessionIds: string[], config?: GetFilesConfig, requestOptions?: AirtopRequestOptions): Promise<AirtopFilesListResponse>;
+    /**
+     * Removes a file by ID.
+     * @param fileId - ID of the file to remove
+     * @param requestOptions - Request options
+     */
+    removeFile(fileId: string, requestOptions?: AirtopRequestOptions): Promise<void>;
+    /**
+     * List all automations
+     * @param requestOptions - Request options
+     */
+    listAutomations(requestOptions?: AirtopRequestOptions): Promise<AirtopAutomationListResponse>;
+    /**
+     * Update the description of a specific automation
+     * @param body - Request body
+     * @param requestOptions - Request options
+     */
+    updateAutomationDescription(body: AirtopAutomationUpdateDescriptionConfig, requestOptions?: AirtopRequestOptions): Promise<AirtopAutomationData>;
+    /**
+     * Delete a specific automation
+     * @param automationID - ID of the automation to delete
+     * @param requestOptions - Request options
+     */
+    removeAutomation(automationID: string, requestOptions?: AirtopRequestOptions): _airtop_core.APIPromise<unknown>;
+}
+
+/**
+ * Enumeration of available plugin augmentation types.
+ * Determines which part of the SDK a plugin can extend.
+ * @group Plugin Development
+ */
+declare enum AirtopPluginAugmentationType {
+    /** Plugin for extending the AirtopClient class */
+    AirtopClient = "AirtopClient",
+    /** Plugin for extending AirtopWindowClient class functionality */
+    AirtopWindowClient = "AirtopWindowClient",
+    /** Plugin for extending AirtopWindow class functionality */
+    AirtopWindow = "AirtopWindow",
+    /** Plugin for extending AirtopSession class functionality */
+    AirtopSessionClient = "AirtopSessionClient",
+    /** Plugin for extending AirtopSession class functionality */
+    AirtopSession = "AirtopSession",
+    /** Plugin for extending AirtopWindowScreenshot class functionality */
+    AirtopWindowScreenshot = "AirtopWindowScreenshot"
+}
+/**
+ * Interface for plugins that extend the main AirtopClient class.
+ * Plugins allow you to add custom functionality to the AirtopClient prototype.
+ *
+ * @group Plugin Development
+ */
+interface AirtopClientPlugin {
+    /**
+     * Specifies that this plugin augments the main AirtopClient class.
+     * This type discrimination allows TypeScript to properly type-check plugin usage.
+     */
+    augmentationType: AirtopPluginAugmentationType.AirtopClient;
+    /**
+     * Function that performs the augmentation of the AirtopClient prototype.
+     *
+     * @param prototype - The AirtopClient class prototype being augmented
+     */
+    augment: (prototype: typeof AirtopClient.prototype) => void;
+}
+/**
+ * Interface for plugins that extend the AirtopWindowClient class functionality.
+ * These plugins can modify or enhance the behavior of all window instances
+ * by modifying the prototype.
+ *
+ * @group Plugin Development
+ */
+interface AirtopWindowClientPlugin {
+    /**
+     * Specifies that this plugin augments AirtopWindowClient class functionality.
+     * This type discrimination ensures proper type checking when using window plugins.
+     */
+    augmentationType: AirtopPluginAugmentationType.AirtopWindowClient;
+    /**
+     * Function that performs the augmentation of the AirtopWindowClient prototype.
+     *
+     * @param prototype - The AirtopWindowClient class prototype being augmented
+     */
+    augment: (prototype: typeof AirtopWindowClient.prototype) => void;
+}
+/**
+ * Interface for plugins that extend the AirtopSessionClient class functionality.
+ * These plugins can modify or enhance the behavior of all session instances
+ * by modifying the prototype.
+ *
+ * @group Plugin Development
+ */
+interface AirtopSessionClientPlugin {
+    /**
+     * Specifies that this plugin augments AirtopSessionClient class functionality.
+     * This type discrimination ensures proper type checking when using session plugins.
+     */
+    augmentationType: AirtopPluginAugmentationType.AirtopSessionClient;
+    /**
+     * Function that performs the augmentation of the AirtopSessionClient prototype.
+     *
+     * @param prototype - The AirtopSessionClient class prototype being augmented
+     */
+    augment: (prototype: typeof AirtopSessionClient.prototype) => void;
+}
+/**
+ * Interface for plugins that extend the AirtopWindow class functionality.
+ * These plugins can modify or enhance the behavior of window instances
+ * by modifying the prototype.
+ *
+ * @group Plugin Development
+ */
+interface AirtopWindowPlugin {
+    /**
+     * Specifies that this plugin augments AirtopWindow class functionality.
+     * This type discrimination ensures proper type checking when using window plugins.
+     */
+    augmentationType: AirtopPluginAugmentationType.AirtopWindow;
+    /**
+     * Function that performs the augmentation of the AirtopWindow prototype.
+     *
+     * @param prototype - The AirtopWindow class prototype being augmented
+     */
+    augment: (prototype: typeof AirtopWindow.prototype) => void;
+}
+/**
+ * Interface for plugins that extend the AirtopSession class functionality.
+ * These plugins can modify or enhance the behavior of session instances
+ * by modifying the prototype.
+ *
+ * @group Plugin Development
+ */
+interface AirtopSessionPlugin {
+    /**
+     * Specifies that this plugin augments AirtopSession class functionality.
+     * This type discrimination ensures proper type checking when using session plugins.
+     */
+    augmentationType: AirtopPluginAugmentationType.AirtopSession;
+    /**
+     * Function that performs the augmentation of the AirtopSession prototype.
+     *
+     * @param prototype - The AirtopSession class prototype being augmented
+     */
+    augment: (prototype: typeof AirtopSession.prototype) => void;
+}
+/**
+ * Interface for plugins that extend the AirtopWindowScreenshot class functionality.
+ * These plugins can modify or enhance the behavior of screenshot instances
+ * by modifying the prototype.
+ *
+ * @group Plugin Development
+ */
+interface AirtopWindowScreenshotPlugin {
+    /**
+     * Specifies that this plugin augments AirtopWindowScreenshot class functionality.
+     * This type discrimination ensures proper type checking when using screenshot plugins.
+     */
+    augmentationType: AirtopPluginAugmentationType.AirtopWindowScreenshot;
+    /**
+     * Function that performs the augmentation of the AirtopWindowScreenshot prototype.
+     *
+     * @param prototype - The AirtopWindowScreenshot class prototype being augmented
+     */
+    augment: (prototype: typeof AirtopWindowScreenshot.prototype) => void;
+}
+/**
+ * Union type of all possible plugin types.
+ * Used when handling plugins generically.
+ *
+ * @group Plugin Development
+ *
+ * @see {@link AirtopClientPlugin | AirtopClientPlugin}
+ * @see {@link AirtopWindowClientPlugin | AirtopWindowClientPlugin}
+ * @see {@link AirtopSessionClientPlugin | AirtopSessionClientPlugin}
+ * @see {@link AirtopWindowPlugin | AirtopWindowPlugin}
+ * @see {@link AirtopSessionPlugin | AirtopSessionPlugin}
+ * @see {@link AirtopWindowScreenshotPlugin | AirtopWindowScreenshotPlugin}
+ */
+type AirtopPluginType = AirtopClientPlugin | AirtopWindowClientPlugin | AirtopSessionClientPlugin | AirtopWindowPlugin | AirtopSessionPlugin | AirtopWindowScreenshotPlugin;
+/**
+ * Interface for registering plugins with the SDK.
+ */
+interface AirtopPluginRegistration {
+    /**
+     * Array of plugins to add to the SDK.
+     */
+    pluginsToAdd: AirtopPluginType[];
+}
+
+/**
+ * Registers a plugin with the SDK.
+ * @param plugin - The plugin to register
+ */
+declare function registerAirtopPlugin(plugin: AirtopPluginRegistration): void;
+
+/**
+ * Provides utility methods for creating mock instances of Airtop classes.
+ * @hideconstructor
+ */
+declare class AirtopMocks {
+    /**
+     * Creates an AirtopBase instance (the class used as the base for other Airtop classes) with a mock client and logger.
+     */
+    static getAirtopBaseMock(config?: Partial<CommonAirtopConfig>): AirtopBase;
+    /**
+     * Creates an Airtop instance with a mock client and data.
+     */
+    static getAirtopClientMock(config?: Partial<AirtopConstructorConfig>): AirtopClient;
+    /**
+     * Creates an AirtopSession instance with a mock client and data.
+     */
+    static getAirtopSessionMock(responseData?: Partial<AirtopSessionResponse>): AirtopSession;
+    /**
+     * Creates an AirtopWindow instance with a mock client and data.
+     */
+    static getAirtopWindowMock({ sessionId, windowData, }?: {
+        sessionId?: string;
+        windowData?: AirtopWindowGetInfoResponse;
+    }): AirtopWindow<AirtopWindowGetInfoResponse>;
+}
+
+export { type AirtopAutomationData, type AirtopAutomationListResponse, type AirtopAutomationUpdateDescriptionConfig, AirtopBase, AirtopClient, type AirtopClientPlugin, type AirtopConstructorConfig, type AirtopFileResponse, type AirtopFilesListResponse, AirtopMocks, AirtopPluginAugmentationType, type AirtopPluginRegistration, type AirtopPluginType, type AirtopProfile, type AirtopRequestOptions, AirtopSession, AirtopSessionClient, type AirtopSessionClientPlugin, type AirtopSessionPlugin, type AirtopSessionResponse, AirtopWindow, AirtopWindowClient, type AirtopWindowClientPlugin, type AirtopWindowCreateResponse, type AirtopWindowGetInfoResponse, type AirtopWindowPlugin, AirtopWindowScreenshot, type AirtopWindowScreenshotPlugin, type AirtopWindowScreenshotResponse, type CommonAirtopConfig, type CommonResponse, type CommonWindowResponse, type CreateFileConfig, type CreateSessionConfig, type GetFilesConfig, type GetSessionsConfig, type OutputJsonSchemaConfig, type ScreenshotData, type SessionData, type SessionError, type SessionMetadata, type SessionWarning, type WindowClickConfig, type WindowCreateData, type WindowError, type WindowGetConfig, type WindowHoverConfig, type WindowInfoData, type WindowLoadUrlConfig, type WindowMetadata, type WindowMonitorConfig, type WindowPageQueryConfig, type WindowPaginatedExtractionConfig, type WindowPromptResponse, type WindowScrapeConfig, type WindowScrapeResponse, type WindowScreenshotConfig, type WindowScrollConfig, type WindowTypeConfig, type WindowWarning, registerAirtopPlugin };