@airtop/sdk 0.0.11 → 0.0.13

package/api/resources/profiles/client/Client.js

@@ -77,8 +77,8 @@ class Profiles {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@airtop/sdk",
-                    "X-Fern-SDK-Version": "0.0.11",
-                    "User-Agent": "@airtop/sdk/0.0.11",
+                    "X-Fern-SDK-Version": "0.0.13",
+                    "User-Agent": "@airtop/sdk/0.0.13",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -148,8 +148,8 @@ class Profiles {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@airtop/sdk",
-                    "X-Fern-SDK-Version": "0.0.11",
-                    "User-Agent": "@airtop/sdk/0.0.11",
+                    "X-Fern-SDK-Version": "0.0.13",
+                    "User-Agent": "@airtop/sdk/0.0.13",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },

package/api/resources/profiles/client/requests/ProfilesDeleteRequest.d.ts

@@ -7,7 +7,7 @@
  */
 export interface ProfilesDeleteRequest {
     /**
-     * A comma separated list of profile ids to search for
+     * A comma-separated list of profile ids.
      */
     profileIds?: string | string[];
 }

package/api/resources/profiles/client/requests/ProfilesGetRequest.d.ts

@@ -7,7 +7,7 @@
  */
 export interface ProfilesGetRequest {
     /**
-     * A comma separated list of profile ids to search for
+     * A comma-separated list of profile ids.
      */
     profileIds?: string | string[];
 }

package/api/resources/sessions/client/Client.d.ts

@@ -64,7 +64,7 @@ export declare class Sessions {
     /**
      * Ends a session by ID. If a given session id does not exist within the organization, it is ignored.
      *
-     * @param {string} id - ID of the session to delete
+     * @param {string} id - ID of the session to delete.
      * @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example

package/api/resources/sessions/client/Client.js

@@ -94,8 +94,8 @@ class Sessions {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@airtop/sdk",
-                    "X-Fern-SDK-Version": "0.0.11",
-                    "User-Agent": "@airtop/sdk/0.0.11",
+                    "X-Fern-SDK-Version": "0.0.13",
+                    "User-Agent": "@airtop/sdk/0.0.13",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -180,8 +180,8 @@ class Sessions {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@airtop/sdk",
-                    "X-Fern-SDK-Version": "0.0.11",
-                    "User-Agent": "@airtop/sdk/0.0.11",
+                    "X-Fern-SDK-Version": "0.0.13",
+                    "User-Agent": "@airtop/sdk/0.0.13",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -245,8 +245,8 @@ class Sessions {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@airtop/sdk",
-                    "X-Fern-SDK-Version": "0.0.11",
-                    "User-Agent": "@airtop/sdk/0.0.11",
+                    "X-Fern-SDK-Version": "0.0.13",
+                    "User-Agent": "@airtop/sdk/0.0.13",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -316,7 +316,7 @@ class Sessions {
     /**
      * Ends a session by ID. If a given session id does not exist within the organization, it is ignored.
      *
-     * @param {string} id - ID of the session to delete
+     * @param {string} id - ID of the session to delete.
      * @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
@@ -332,8 +332,8 @@ class Sessions {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@airtop/sdk",
-                    "X-Fern-SDK-Version": "0.0.11",
-                    "User-Agent": "@airtop/sdk/0.0.11",
+                    "X-Fern-SDK-Version": "0.0.13",
+                    "User-Agent": "@airtop/sdk/0.0.13",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -380,8 +380,8 @@ class Sessions {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@airtop/sdk",
-                    "X-Fern-SDK-Version": "0.0.11",
-                    "User-Agent": "@airtop/sdk/0.0.11",
+                    "X-Fern-SDK-Version": "0.0.13",
+                    "User-Agent": "@airtop/sdk/0.0.13",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },

package/api/resources/sessions/client/requests/SessionsListRequest.d.ts

@@ -11,19 +11,19 @@ import * as Airtop from "../../../../index";
  */
 export interface SessionsListRequest {
     /**
-     * a comma separated list of IDs of the session to get
+     * A comma-separated list of IDs of the sessions to retrieve.
      */
     sessionIds?: string | string[];
     /**
-     * status of the session to get
+     * Status of the session to get.
      */
     status?: Airtop.SessionsListRequestStatus;
     /**
-     * offset for pagination
+     * Offset for pagination.
      */
     offset?: number;
     /**
-     * limit for pagination
+     * Limit for pagination.
      */
     limit?: number;
 }

package/api/resources/sessions/types/SessionsListRequestStatus.d.ts

@@ -2,11 +2,11 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 /**
- * status of the session to get
+ * Status of the session to get.
  */
-export declare type SessionsListRequestStatus = "awaiting_capacity" | "initializing" | "running" | "ended";
+export declare type SessionsListRequestStatus = "awaitingCapacity" | "initializing" | "running" | "ended";
 export declare const SessionsListRequestStatus: {
-    readonly AwaitingCapacity: "awaiting_capacity";
+    readonly AwaitingCapacity: "awaitingCapacity";
     readonly Initializing: "initializing";
     readonly Running: "running";
     readonly Ended: "ended";

package/api/resources/sessions/types/SessionsListRequestStatus.js

@@ -5,7 +5,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SessionsListRequestStatus = void 0;
 exports.SessionsListRequestStatus = {
-    AwaitingCapacity: "awaiting_capacity",
+    AwaitingCapacity: "awaitingCapacity",
     Initializing: "initializing",
     Running: "running",
     Ended: "ended",

package/api/resources/windows/client/Client.d.ts

@@ -23,20 +23,20 @@ export declare class Windows {
     protected readonly _options: Windows.Options;
     constructor(_options?: Windows.Options);
     /**
-     * @param {string} sessionId - ID of the session that owns the window
-     * @param {string} windowId - id of the browser window, either the windowId (uuid) or targetId (simple string)
+     * @param {string} sessionId - ID of the session that owns the window.
+     * @param {string} windowId - ID of the browser window, which can either be a normal AirTop windowId or a [CDP TargetId](https://chromedevtools.github.io/devtools-protocol/tot/Target/#type-TargetID) from a browser automation library like Puppeteer (typically associated with the page or main frame). Our SDKs will handle retrieving a TargetId for you from various popular browser automation libraries, but we also have details in our guides on how to do it manually.
      * @param {Airtop.GetWindowInfoRequest} request
      * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
      *     await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430", {
-     *         screenResolution: "1920x1080"
+     *         screenResolution: "1280x720"
      *     })
      */
     getWindowInfo(sessionId: string, windowId: string, request?: Airtop.GetWindowInfoRequest, requestOptions?: Windows.RequestOptions): Promise<Airtop.WindowEnvelopeDefaultMetaWrapper>;
     /**
-     * @param {string} sessionId - The session id to submit a prompt about
-     * @param {string} windowId - The window id to submit a prompt about
+     * @param {string} sessionId - The session id for the window.
+     * @param {string} windowId - The Airtop window id of the browser window to target with an Airtop AI prompt.
      * @param {Airtop.PromptContentRequest} request
      * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -47,8 +47,8 @@ export declare class Windows {
      */
     promptContent(sessionId: string, windowId: string, request: Airtop.PromptContentRequest, requestOptions?: Windows.RequestOptions): Promise<Airtop.AiResponseEnvelopeExternalSessionAiResponseMetadataWrapper>;
     /**
-     * @param {string} sessionId - The session id to scrape
-     * @param {string} windowId - The window id to scrape
+     * @param {string} sessionId - The session id for the window.
+     * @param {string} windowId - The Airtop window id of the browser window to scrape.
      * @param {Airtop.ScrapeContentRequest} request
      * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -57,8 +57,8 @@ export declare class Windows {
      */
     scrapeContent(sessionId: string, windowId: string, request?: Airtop.ScrapeContentRequest, requestOptions?: Windows.RequestOptions): Promise<Airtop.ScrapeResponseEnvelopeExternalSessionAiResponseMetadataWrapper>;
     /**
-     * @param {string} sessionId - The session id to summarize
-     * @param {string} windowId - The window id to summarize
+     * @param {string} sessionId - The session id for the window.
+     * @param {string} windowId - The Airtop window id of the browser window to summarize.
      * @param {Airtop.SummarizeContentRequest} request
      * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
      *

package/api/resources/windows/client/Client.js

@@ -49,14 +49,14 @@ class Windows {
         this._options = _options;
     }
     /**
-     * @param {string} sessionId - ID of the session that owns the window
-     * @param {string} windowId - id of the browser window, either the windowId (uuid) or targetId (simple string)
+     * @param {string} sessionId - ID of the session that owns the window.
+     * @param {string} windowId - ID of the browser window, which can either be a normal AirTop windowId or a [CDP TargetId](https://chromedevtools.github.io/devtools-protocol/tot/Target/#type-TargetID) from a browser automation library like Puppeteer (typically associated with the page or main frame). Our SDKs will handle retrieving a TargetId for you from various popular browser automation libraries, but we also have details in our guides on how to do it manually.
      * @param {Airtop.GetWindowInfoRequest} request
      * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
      *     await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430", {
-     *         screenResolution: "1920x1080"
+     *         screenResolution: "1280x720"
      *     })
      */
     getWindowInfo(sessionId, windowId, request = {}, requestOptions) {
@@ -71,7 +71,7 @@ class Windows {
                 _queryParams["disableResize"] = disableResize.toString();
             }
             if (screenResolution != null) {
-                _queryParams["Screen resolution"] = screenResolution;
+                _queryParams["screenResolution"] = screenResolution;
             }
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.AirtopEnvironment.Default, `sessions/${encodeURIComponent(sessionId)}/windows/${encodeURIComponent(windowId)}`),
@@ -80,8 +80,8 @@ class Windows {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@airtop/sdk",
-                    "X-Fern-SDK-Version": "0.0.11",
-                    "User-Agent": "@airtop/sdk/0.0.11",
+                    "X-Fern-SDK-Version": "0.0.13",
+                    "User-Agent": "@airtop/sdk/0.0.13",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -123,8 +123,8 @@ class Windows {
         });
     }
     /**
-     * @param {string} sessionId - The session id to submit a prompt about
-     * @param {string} windowId - The window id to submit a prompt about
+     * @param {string} sessionId - The session id for the window.
+     * @param {string} windowId - The Airtop window id of the browser window to target with an Airtop AI prompt.
      * @param {Airtop.PromptContentRequest} request
      * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -143,8 +143,8 @@ class Windows {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@airtop/sdk",
-                    "X-Fern-SDK-Version": "0.0.11",
-                    "User-Agent": "@airtop/sdk/0.0.11",
+                    "X-Fern-SDK-Version": "0.0.13",
+                    "User-Agent": "@airtop/sdk/0.0.13",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -186,8 +186,8 @@ class Windows {
         });
     }
     /**
-     * @param {string} sessionId - The session id to scrape
-     * @param {string} windowId - The window id to scrape
+     * @param {string} sessionId - The session id for the window.
+     * @param {string} windowId - The Airtop window id of the browser window to scrape.
      * @param {Airtop.ScrapeContentRequest} request
      * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -204,8 +204,8 @@ class Windows {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@airtop/sdk",
-                    "X-Fern-SDK-Version": "0.0.11",
-                    "User-Agent": "@airtop/sdk/0.0.11",
+                    "X-Fern-SDK-Version": "0.0.13",
+                    "User-Agent": "@airtop/sdk/0.0.13",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -247,8 +247,8 @@ class Windows {
         });
     }
     /**
-     * @param {string} sessionId - The session id to summarize
-     * @param {string} windowId - The window id to summarize
+     * @param {string} sessionId - The session id for the window.
+     * @param {string} windowId - The Airtop window id of the browser window to summarize.
      * @param {Airtop.SummarizeContentRequest} request
      * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -265,8 +265,8 @@ class Windows {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@airtop/sdk",
-                    "X-Fern-SDK-Version": "0.0.11",
-                    "User-Agent": "@airtop/sdk/0.0.11",
+                    "X-Fern-SDK-Version": "0.0.13",
+                    "User-Agent": "@airtop/sdk/0.0.13",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },

package/api/resources/windows/client/requests/GetWindowInfoRequest.d.ts

@@ -4,20 +4,20 @@
 /**
  * @example
  *     {
- *         screenResolution: "1920x1080"
+ *         screenResolution: "1280x720"
  *     }
  */
 export interface GetWindowInfoRequest {
     /**
-     * Renders a navigation bar as part of the live view session
+     * Affects the live view configuration. A navigation bar is not shown in the live view of a browser by default. Set this to true to configure the returned liveViewUrl so that a navigation bar is rendered, allowing users to easily navigate the browser to other pages from the live view.
      */
     includeNavigationBar?: boolean;
     /**
-     * By default browsers will adapt its resolution to the live view window size. This flag disables that behavior
+     * Affects the live view configuration. Set to true to configure the returned liveViewUrl so that the ability to resize the browser window from the live view is disabled (resizing is allowed by default). Note that, at initial load, the live view will automatically fill the parent frame (or local window if loaded directly) and cause the browser window to be resized to match. This parameter does not affect that initial load behavior. See screenResolution for a way to set a fixed size for the live view.
      */
     disableResize?: boolean;
     /**
-     * Ex: Screen resolution of the live view in format wxh, e.g. 1920x1080. When this value is provided the live view won't adapt it's resolution to the live view window size
+     * Affects the live view configuration. By default, a live view will fill the parent frame (or local window if loaded directly) when initially loaded, causing the browser window to be resized to match. This parameter can be used to instead configure the returned liveViewUrl so that the live view is loaded with fixed dimensions (e.g. 1280x720), resizing the browser window to match, and then disallows any further resizing from the live view.
      */
     screenResolution?: string;
 }

package/api/resources/windows/client/requests/PromptContentRequest.d.ts

@@ -9,10 +9,16 @@
  */
 export interface PromptContentRequest {
     clientRequestId?: string;
+    /** A credit threshold that, once exceeded, will cause the operation to be cancelled. Note that this is *not* a hard limit, but a threshold that is checked periodically during the course of fulfilling the request. A default threshold is used if not specified, but you can use this option to increase or decrease as needed. Set to 0 to disable this feature entirely (not recommended). */
     costThresholdCredits?: number;
-    /** Whether to follow pagination links in the content and load additional results */
+    /** Make a best effort attempt to load more content items than are originally displayed on the page, e.g. by following pagination links, clicking controls to load more content, utilizing infinite scrolling, etc. This can be quite a bit more costly, but may be necessary for sites that require additional interaction to show the needed results. You can provide constraints in your prompt (e.g. on the total number of pages or results to consider). */
     followPaginationLinks?: boolean;
-    /** The prompt to submit about the content in the browser window */
+    /** The prompt to submit about the content in the browser window. */
     prompt: string;
+    /**
+     * A time threshold in seconds that, once exceeded, will cause the operation to be cancelled. Note that this is *not* a hard limit, but a threshold that is checked periodically during the course of fulfilling the request. A default threshold is used if not specified, but you can use this option to increase or decrease as needed. Set to 0 to disable this feature entirely (not recommended).
+     *
+     * This setting does not extend the maximum session duration provided at the time of session creation.
+     */
     timeThresholdSeconds?: number;
 }

package/api/resources/windows/client/requests/ScrapeContentRequest.d.ts

@@ -7,6 +7,12 @@
  */
 export interface ScrapeContentRequest {
     clientRequestId?: string;
+    /** A credit threshold that, once exceeded, will cause the operation to be cancelled. Note that this is *not* a hard limit, but a threshold that is checked periodically during the course of fulfilling the request. A default threshold is used if not specified, but you can use this option to increase or decrease as needed. Set to 0 to disable this feature entirely (not recommended). */
     costThresholdCredits?: number;
+    /**
+     * A time threshold in seconds that, once exceeded, will cause the operation to be cancelled. Note that this is *not* a hard limit, but a threshold that is checked periodically during the course of fulfilling the request. A default threshold is used if not specified, but you can use this option to increase or decrease as needed. Set to 0 to disable this feature entirely (not recommended).
+     *
+     * This setting does not extend the maximum session duration provided at the time of session creation.
+     */
     timeThresholdSeconds?: number;
 }

package/api/resources/windows/client/requests/SummarizeContentRequest.d.ts

@@ -7,8 +7,14 @@
  */
 export interface SummarizeContentRequest {
     clientRequestId?: string;
+    /** A credit threshold that, once exceeded, will cause the operation to be cancelled. Note that this is *not* a hard limit, but a threshold that is checked periodically during the course of fulfilling the request. A default threshold is used if not specified, but you can use this option to increase or decrease as needed. Set to 0 to disable this feature entirely (not recommended). */
     costThresholdCredits?: number;
-    /** The prompt to submit about the content in the browser window */
+    /** An optional prompt providing the Airtop AI model with additional direction or constraints about the summary (such as desired length). */
     prompt?: string;
+    /**
+     * A time threshold in seconds that, once exceeded, will cause the operation to be cancelled. Note that this is *not* a hard limit, but a threshold that is checked periodically during the course of fulfilling the request. A default threshold is used if not specified, but you can use this option to increase or decrease as needed. Set to 0 to disable this feature entirely (not recommended).
+     *
+     * This setting does not extend the maximum session duration provided at the time of session creation.
+     */
     timeThresholdSeconds?: number;
 }

package/api/types/AiResponseEnvelope.d.ts

@@ -1,9 +1,6 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Airtop from "../index";
 export interface AiResponseEnvelope {
-    errors?: Airtop.Issue[];
     modelResponse: string;
-    warnings?: Airtop.Issue[];
 }

package/api/types/ExternalProfileV1.d.ts

@@ -2,8 +2,8 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface ExternalProfileV1 {
-    /** Id of the profile */
+    /** Id of the profile. */
     profileId: string;
-    /** Status of the profile */
+    /** Status of the profile. */
     status?: string;
 }

package/api/types/ExternalSessionAiResponseMetadata.d.ts

@@ -5,6 +5,7 @@ import * as Airtop from "../index";
 export interface ExternalSessionAiResponseMetadata {
     clientProvided?: Airtop.ClientProvidedResponseMetadata;
     requestId?: string;
+    /** Outcome of the operation. */
     status: Airtop.ExternalSessionAiResponseMetadataStatus;
     usage: Airtop.ExternalSessionAiResponseMetadataUsage;
 }

package/api/types/ExternalSessionAiResponseMetadataStatus.d.ts

@@ -1,6 +1,9 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * Outcome of the operation.
+ */
 export declare type ExternalSessionAiResponseMetadataStatus = "success" | "partial" | "failure";
 export declare const ExternalSessionAiResponseMetadataStatus: {
     readonly Success: "success";

package/api/types/ExternalSessionConfig.d.ts

@@ -2,10 +2,10 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface ExternalSessionConfig {
-    /** Id of a profile to use with this session */
+    /** Id of a profile to load into the session. */
     baseProfileId?: string;
-    /** Persist the profile */
+    /** Persist the profile. */
     persistProfile?: boolean;
-    /** Max length of session in minutes, after which it will terminate if not already deleted */
+    /** Max length of session in minutes, after which it will terminate if not already deleted. */
     timeoutMinutes?: number;
 }

package/api/types/ExternalSessionWithConnectionInfo.d.ts

@@ -3,22 +3,24 @@
  */
 import * as Airtop from "../index";
 export interface ExternalSessionWithConnectionInfo {
-    /** Url to connect to chrome devtools protocol port on the airtop browser. Include the header 'Authorization: Bearer <api-key>.' */
+    /** Url to connect to chrome devtools protocol port on the Airtop browser. Include the header 'Authorization: Bearer <api-key>.' */
     cdpUrl?: string;
-    /** Websocket url to connect to CDP webSocketDebuggerUrl on the airtop browser. Include the header 'Authorization: Bearer <api-key>.' */
+    /** Websocket url to connect to the Airtop browser for CDP-based automation frameworks (e.g. Puppeteer or Playwright). Include the header 'Authorization: Bearer <airtop-api-key>.' */
     cdpWsUrl?: string;
-    /** Websocket url to connect to the chromedriver on the airtop browser. Include the header 'Authorization: Bearer <api-key>.' */
+    /** Websocket url to connect to the Airtop browser for webdriver-based automation frameworks (e.g. Selenium). Include the header 'Authorization: Bearer <airtop-api-key>.' */
     chromedriverUrl?: string;
-    /** Session configuration */
+    /** Session configuration details. */
     configuration: Airtop.ExternalSessionConfig;
-    /** Current usage in minutes */
+    /** Current usage in minutes. */
     currentUsage?: number;
-    /** Date the session was created */
+    /** Date the session was created. */
     dateCreated?: Date;
-    /** UUID of the session */
+    /** Id of the session. */
     id: string;
-    /** Date of the last activity */
+    /** Date of the last activity. */
     lastActivity?: Date;
-    /** Session status */
+    /** Id of a newly persisted profile. */
+    profileId?: string;
+    /** Session status. */
     status: string;
 }

package/api/types/Issue.d.ts

@@ -2,10 +2,10 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface Issue {
-    /** Issue code */
+    /** Issue code. */
     code?: string;
-    /** Any associated details */
+    /** Any associated details. */
     details?: Record<string, unknown>;
-    /** Message describing the issue */
+    /** Message describing the issue. */
     message: string;
 }

package/api/types/ScrapeResponseContent.d.ts

@@ -2,8 +2,8 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface ScrapeResponseContent {
-    /** The mime type of content extracted from the browser window */
+    /** The mime type of content extracted from the browser window (usually text/plain but could be text/csv or other types depending on the site). */
     contentType: string;
-    /** The text content of the browser window */
+    /** The text content of the browser window. */
     text: string;
 }

package/api/types/ScrapeResponseEnvelope.d.ts

@@ -3,7 +3,6 @@
  */
 import * as Airtop from "../index";
 export interface ScrapeResponseEnvelope {
-    errors?: Airtop.Issue[];
+    /** The response from the Airtop AI model. */
     modelResponse: Airtop.ScrapeResponseOutput;
-    warnings?: Airtop.Issue[];
 }

package/api/types/ScrapeResponseOutput.d.ts

@@ -3,10 +3,10 @@
  */
 import * as Airtop from "../index";
 export interface ScrapeResponseOutput {
-    /** The scraped content of the browser window */
+    /** The scraped content of the browser window. */
     scrapedContent: Airtop.ScrapeResponseContent;
-    /** Any text that was highlighted in the browser window */
+    /** Any text that was highlighted in the browser window. */
     selectedText?: string;
-    /** The title of the browser page */
+    /** The title of the browser page. */
     title: string;
 }

package/api/types/SessionConfigV1.d.ts

@@ -2,10 +2,10 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface SessionConfigV1 {
-    /** Persist the profile */
+    /** Id of a profile to load into the session. */
+    baseProfileId?: string;
+    /** Persist the profile. */
     persistProfile?: boolean;
-    /** Id of a profile to use with this session */
-    profileId?: string;
-    /** Max length of session in minutes, after which it will terminate if not already deleted */
+    /** Max length of session in minutes, after which it will terminate if not already deleted. */
     timeoutMinutes?: number;
 }

package/api/types/SessionsWithPagination.d.ts

@@ -3,8 +3,8 @@
  */
 import * as Airtop from "../index";
 export interface SessionsWithPagination {
-    /** Pagination info */
+    /** Pagination details. */
     pagination: Airtop.Pagination;
-    /** List of sessions */
+    /** List of sessions. */
     sessions?: Airtop.ExternalSessionWithConnectionInfo[];
 }

package/api/types/Window.d.ts

@@ -2,8 +2,8 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface Window {
-    /** Url for live view session */
+    /** Url for loading a browser window live view that is configured according to the request options like screenResolution, disableResize, etc. */
     liveViewUrl: string;
-    /** Window ID for live view session */
+    /** Airtop window ID of the browser window */
     windowId: string;
 }

package/dist/api/resources/profiles/client/Client.js

@@ -77,8 +77,8 @@ class Profiles {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@airtop/sdk",
-                    "X-Fern-SDK-Version": "0.0.11",
-                    "User-Agent": "@airtop/sdk/0.0.11",
+                    "X-Fern-SDK-Version": "0.0.13",
+                    "User-Agent": "@airtop/sdk/0.0.13",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -148,8 +148,8 @@ class Profiles {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@airtop/sdk",
-                    "X-Fern-SDK-Version": "0.0.11",
-                    "User-Agent": "@airtop/sdk/0.0.11",
+                    "X-Fern-SDK-Version": "0.0.13",
+                    "User-Agent": "@airtop/sdk/0.0.13",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },

package/dist/api/resources/profiles/client/requests/ProfilesDeleteRequest.d.ts

@@ -7,7 +7,7 @@
  */
 export interface ProfilesDeleteRequest {
     /**
-     * A comma separated list of profile ids to search for
+     * A comma-separated list of profile ids.
      */
     profileIds?: string | string[];
 }