@onkernel/sdk 0.19.2 → 0.21.0

package/src/resources/browsers/browsers.ts

@@ -1,7 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
-import * as BrowsersAPI from './browsers';
+import * as Shared from '../shared';
 import * as ComputerAPI from './computer';
 import {
   Computer,
@@ -63,6 +63,7 @@ import {
   Fs,
 } from './fs/fs';
 import { APIPromise } from '../../core/api-promise';
+import { OffsetPagination, type OffsetPaginationParams, PagePromise } from '../../core/pagination';
 import { type Uploadable } from '../../core/uploads';
 import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
@@ -107,15 +108,22 @@ export class Browsers extends APIResource {
   }
 
   /**
-   * List active browser sessions
+   * List all browser sessions with pagination support. Use include_deleted=true to
+   * include soft-deleted sessions in the results.
    *
    * @example
    * ```ts
-   * const browsers = await client.browsers.list();
+   * // Automatically fetches more pages as needed.
+   * for await (const browserListResponse of client.browsers.list()) {
+   *   // ...
+   * }
    * ```
    */
-  list(options?: RequestOptions): APIPromise<BrowserListResponse> {
-    return this._client.get('/browsers', options);
+  list(
+    query: BrowserListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<BrowserListResponsesOffsetPagination, BrowserListResponse> {
+    return this._client.getAPIList('/browsers', OffsetPagination<BrowserListResponse>, { query, ...options });
   }
 
   /**
@@ -181,6 +189,8 @@ export class Browsers extends APIResource {
   }
 }
 
+export type BrowserListResponsesOffsetPagination = OffsetPagination<BrowserListResponse>;
+
 /**
  * Optional persistence configuration for the browser session.
  */
@@ -258,6 +268,11 @@ export interface BrowserCreateResponse {
    */
   browser_live_view_url?: string;
 
+  /**
+   * When the browser session was soft-deleted. Only present for deleted sessions.
+   */
+  deleted_at?: string;
+
   /**
    * Whether the browser session is running in kiosk mode.
    */
@@ -288,37 +303,7 @@ export interface BrowserCreateResponse {
    * configuration exactly. Note: Higher resolutions may affect the responsiveness of
    * live view browser
    */
-  viewport?: BrowserCreateResponse.Viewport;
-}
-
-export namespace BrowserCreateResponse {
-  /**
-   * Initial browser window size in pixels with optional refresh rate. If omitted,
-   * image defaults apply (commonly 1024x768@60). Only specific viewport
-   * configurations are supported. The server will reject unsupported combinations.
-   * Supported resolutions are: 2560x1440@10, 1920x1080@25, 1920x1200@25,
-   * 1440x900@25, 1024x768@60, 1200x800@60 If refresh_rate is not provided, it will
-   * be automatically determined from the width and height if they match a supported
-   * configuration exactly. Note: Higher resolutions may affect the responsiveness of
-   * live view browser
-   */
-  export interface Viewport {
-    /**
-     * Browser window height in pixels.
-     */
-    height: number;
-
-    /**
-     * Browser window width in pixels.
-     */
-    width: number;
-
-    /**
-     * Display refresh rate in Hz. If omitted, automatically determined from width and
-     * height.
-     */
-    refresh_rate?: number;
-  }
+  viewport?: Shared.BrowserViewport;
 }
 
 export interface BrowserRetrieveResponse {
@@ -358,6 +343,11 @@ export interface BrowserRetrieveResponse {
    */
   browser_live_view_url?: string;
 
+  /**
+   * When the browser session was soft-deleted. Only present for deleted sessions.
+   */
+  deleted_at?: string;
+
   /**
    * Whether the browser session is running in kiosk mode.
    */
@@ -388,148 +378,89 @@ export interface BrowserRetrieveResponse {
    * configuration exactly. Note: Higher resolutions may affect the responsiveness of
    * live view browser
    */
-  viewport?: BrowserRetrieveResponse.Viewport;
+  viewport?: Shared.BrowserViewport;
 }
 
-export namespace BrowserRetrieveResponse {
+export interface BrowserListResponse {
   /**
-   * Initial browser window size in pixels with optional refresh rate. If omitted,
-   * image defaults apply (commonly 1024x768@60). Only specific viewport
-   * configurations are supported. The server will reject unsupported combinations.
-   * Supported resolutions are: 2560x1440@10, 1920x1080@25, 1920x1200@25,
-   * 1440x900@25, 1024x768@60, 1200x800@60 If refresh_rate is not provided, it will
-   * be automatically determined from the width and height if they match a supported
-   * configuration exactly. Note: Higher resolutions may affect the responsiveness of
-   * live view browser
+   * Websocket URL for Chrome DevTools Protocol connections to the browser session
    */
-  export interface Viewport {
-    /**
-     * Browser window height in pixels.
-     */
-    height: number;
-
-    /**
-     * Browser window width in pixels.
-     */
-    width: number;
-
-    /**
-     * Display refresh rate in Hz. If omitted, automatically determined from width and
-     * height.
-     */
-    refresh_rate?: number;
-  }
-}
-
-export type BrowserListResponse = Array<BrowserListResponse.BrowserListResponseItem>;
-
-export namespace BrowserListResponse {
-  export interface BrowserListResponseItem {
-    /**
-     * Websocket URL for Chrome DevTools Protocol connections to the browser session
-     */
-    cdp_ws_url: string;
+  cdp_ws_url: string;
 
-    /**
-     * When the browser session was created.
-     */
-    created_at: string;
+  /**
+   * When the browser session was created.
+   */
+  created_at: string;
 
-    /**
-     * Whether the browser session is running in headless mode.
-     */
-    headless: boolean;
+  /**
+   * Whether the browser session is running in headless mode.
+   */
+  headless: boolean;
 
-    /**
-     * Unique identifier for the browser session
-     */
-    session_id: string;
+  /**
+   * Unique identifier for the browser session
+   */
+  session_id: string;
 
-    /**
-     * Whether the browser session is running in stealth mode.
-     */
-    stealth: boolean;
+  /**
+   * Whether the browser session is running in stealth mode.
+   */
+  stealth: boolean;
 
-    /**
-     * The number of seconds of inactivity before the browser session is terminated.
-     */
-    timeout_seconds: number;
+  /**
+   * The number of seconds of inactivity before the browser session is terminated.
+   */
+  timeout_seconds: number;
 
-    /**
-     * Remote URL for live viewing the browser session. Only available for non-headless
-     * browsers.
-     */
-    browser_live_view_url?: string;
+  /**
+   * Remote URL for live viewing the browser session. Only available for non-headless
+   * browsers.
+   */
+  browser_live_view_url?: string;
 
-    /**
-     * Whether the browser session is running in kiosk mode.
-     */
-    kiosk_mode?: boolean;
+  /**
+   * When the browser session was soft-deleted. Only present for deleted sessions.
+   */
+  deleted_at?: string;
 
-    /**
-     * Optional persistence configuration for the browser session.
-     */
-    persistence?: BrowsersAPI.BrowserPersistence;
+  /**
+   * Whether the browser session is running in kiosk mode.
+   */
+  kiosk_mode?: boolean;
 
-    /**
-     * Browser profile metadata.
-     */
-    profile?: BrowsersAPI.Profile;
+  /**
+   * Optional persistence configuration for the browser session.
+   */
+  persistence?: BrowserPersistence;
 
-    /**
-     * ID of the proxy associated with this browser session, if any.
-     */
-    proxy_id?: string;
+  /**
+   * Browser profile metadata.
+   */
+  profile?: Profile;
 
-    /**
-     * Initial browser window size in pixels with optional refresh rate. If omitted,
-     * image defaults apply (commonly 1024x768@60). Only specific viewport
-     * configurations are supported. The server will reject unsupported combinations.
-     * Supported resolutions are: 2560x1440@10, 1920x1080@25, 1920x1200@25,
-     * 1440x900@25, 1024x768@60, 1200x800@60 If refresh_rate is not provided, it will
-     * be automatically determined from the width and height if they match a supported
-     * configuration exactly. Note: Higher resolutions may affect the responsiveness of
-     * live view browser
-     */
-    viewport?: BrowserListResponseItem.Viewport;
-  }
+  /**
+   * ID of the proxy associated with this browser session, if any.
+   */
+  proxy_id?: string;
 
-  export namespace BrowserListResponseItem {
-    /**
-     * Initial browser window size in pixels with optional refresh rate. If omitted,
-     * image defaults apply (commonly 1024x768@60). Only specific viewport
-     * configurations are supported. The server will reject unsupported combinations.
-     * Supported resolutions are: 2560x1440@10, 1920x1080@25, 1920x1200@25,
-     * 1440x900@25, 1024x768@60, 1200x800@60 If refresh_rate is not provided, it will
-     * be automatically determined from the width and height if they match a supported
-     * configuration exactly. Note: Higher resolutions may affect the responsiveness of
-     * live view browser
-     */
-    export interface Viewport {
-      /**
-       * Browser window height in pixels.
-       */
-      height: number;
-
-      /**
-       * Browser window width in pixels.
-       */
-      width: number;
-
-      /**
-       * Display refresh rate in Hz. If omitted, automatically determined from width and
-       * height.
-       */
-      refresh_rate?: number;
-    }
-  }
+  /**
+   * Initial browser window size in pixels with optional refresh rate. If omitted,
+   * image defaults apply (commonly 1024x768@60). Only specific viewport
+   * configurations are supported. The server will reject unsupported combinations.
+   * Supported resolutions are: 2560x1440@10, 1920x1080@25, 1920x1200@25,
+   * 1440x900@25, 1024x768@60, 1200x800@60 If refresh_rate is not provided, it will
+   * be automatically determined from the width and height if they match a supported
+   * configuration exactly. Note: Higher resolutions may affect the responsiveness of
+   * live view browser
+   */
+  viewport?: Shared.BrowserViewport;
 }
 
 export interface BrowserCreateParams {
   /**
    * List of browser extensions to load into the session. Provide each by id or name.
    */
-  extensions?: Array<BrowserCreateParams.Extension>;
+  extensions?: Array<Shared.BrowserExtension>;
 
   /**
    * If true, launches the browser using a headless image (no VNC/GUI). Defaults to
@@ -558,7 +489,7 @@ export interface BrowserCreateParams {
    * specified, the matching profile will be loaded into the browser session.
    * Profiles must be created beforehand.
    */
-  profile?: BrowserCreateParams.Profile;
+  profile?: Shared.BrowserProfile;
 
   /**
    * Optional proxy to associate to the browser session. Must reference a proxy
@@ -592,78 +523,15 @@ export interface BrowserCreateParams {
    * configuration exactly. Note: Higher resolutions may affect the responsiveness of
    * live view browser
    */
-  viewport?: BrowserCreateParams.Viewport;
+  viewport?: Shared.BrowserViewport;
 }
 
-export namespace BrowserCreateParams {
-  /**
-   * Extension selection for the browser session. Provide either id or name of an
-   * extension uploaded to Kernel.
-   */
-  export interface Extension {
-    /**
-     * Extension ID to load for this browser session
-     */
-    id?: string;
-
-    /**
-     * Extension name to load for this browser session (instead of id). Must be 1-255
-     * characters, using letters, numbers, dots, underscores, or hyphens.
-     */
-    name?: string;
-  }
-
+export interface BrowserListParams extends OffsetPaginationParams {
   /**
-   * Profile selection for the browser session. Provide either id or name. If
-   * specified, the matching profile will be loaded into the browser session.
-   * Profiles must be created beforehand.
+   * When true, includes soft-deleted browser sessions in the results alongside
+   * active sessions.
    */
-  export interface Profile {
-    /**
-     * Profile ID to load for this browser session
-     */
-    id?: string;
-
-    /**
-     * Profile name to load for this browser session (instead of id). Must be 1-255
-     * characters, using letters, numbers, dots, underscores, or hyphens.
-     */
-    name?: string;
-
-    /**
-     * If true, save changes made during the session back to the profile when the
-     * session ends.
-     */
-    save_changes?: boolean;
-  }
-
-  /**
-   * Initial browser window size in pixels with optional refresh rate. If omitted,
-   * image defaults apply (commonly 1024x768@60). Only specific viewport
-   * configurations are supported. The server will reject unsupported combinations.
-   * Supported resolutions are: 2560x1440@10, 1920x1080@25, 1920x1200@25,
-   * 1440x900@25, 1024x768@60, 1200x800@60 If refresh_rate is not provided, it will
-   * be automatically determined from the width and height if they match a supported
-   * configuration exactly. Note: Higher resolutions may affect the responsiveness of
-   * live view browser
-   */
-  export interface Viewport {
-    /**
-     * Browser window height in pixels.
-     */
-    height: number;
-
-    /**
-     * Browser window width in pixels.
-     */
-    width: number;
-
-    /**
-     * Display refresh rate in Hz. If omitted, automatically determined from width and
-     * height.
-     */
-    refresh_rate?: number;
-  }
+  include_deleted?: boolean;
 }
 
 export interface BrowserDeleteParams {
@@ -709,7 +577,9 @@ export declare namespace Browsers {
     type BrowserCreateResponse as BrowserCreateResponse,
     type BrowserRetrieveResponse as BrowserRetrieveResponse,
     type BrowserListResponse as BrowserListResponse,
+    type BrowserListResponsesOffsetPagination as BrowserListResponsesOffsetPagination,
     type BrowserCreateParams as BrowserCreateParams,
+    type BrowserListParams as BrowserListParams,
     type BrowserDeleteParams as BrowserDeleteParams,
     type BrowserLoadExtensionsParams as BrowserLoadExtensionsParams,
   };

package/src/resources/browsers/index.ts

@@ -8,8 +8,10 @@ export {
   type BrowserRetrieveResponse,
   type BrowserListResponse,
   type BrowserCreateParams,
+  type BrowserListParams,
   type BrowserDeleteParams,
   type BrowserLoadExtensionsParams,
+  type BrowserListResponsesOffsetPagination,
 } from './browsers';
 export {
   Computer,

package/src/resources/index.ts

@@ -7,6 +7,21 @@ export {
   type AppListParams,
   type AppListResponsesOffsetPagination,
 } from './apps';
+export {
+  BrowserPools,
+  type BrowserPool,
+  type BrowserPoolAcquireRequest,
+  type BrowserPoolReleaseRequest,
+  type BrowserPoolRequest,
+  type BrowserPoolUpdateRequest,
+  type BrowserPoolListResponse,
+  type BrowserPoolAcquireResponse,
+  type BrowserPoolCreateParams,
+  type BrowserPoolUpdateParams,
+  type BrowserPoolDeleteParams,
+  type BrowserPoolAcquireParams,
+  type BrowserPoolReleaseParams,
+} from './browser-pools';
 export {
   Browsers,
   type BrowserPersistence,
@@ -15,8 +30,10 @@ export {
   type BrowserRetrieveResponse,
   type BrowserListResponse,
   type BrowserCreateParams,
+  type BrowserListParams,
   type BrowserDeleteParams,
   type BrowserLoadExtensionsParams,
+  type BrowserListResponsesOffsetPagination,
 } from './browsers/browsers';
 export {
   Deployments,

package/src/resources/shared.ts

@@ -10,6 +10,75 @@ export interface AppAction {
   name: string;
 }
 
+/**
+ * Extension selection for the browser session. Provide either id or name of an
+ * extension uploaded to Kernel.
+ */
+export interface BrowserExtension {
+  /**
+   * Extension ID to load for this browser session
+   */
+  id?: string;
+
+  /**
+   * Extension name to load for this browser session (instead of id). Must be 1-255
+   * characters, using letters, numbers, dots, underscores, or hyphens.
+   */
+  name?: string;
+}
+
+/**
+ * Profile selection for the browser session. Provide either id or name. If
+ * specified, the matching profile will be loaded into the browser session.
+ * Profiles must be created beforehand.
+ */
+export interface BrowserProfile {
+  /**
+   * Profile ID to load for this browser session
+   */
+  id?: string;
+
+  /**
+   * Profile name to load for this browser session (instead of id). Must be 1-255
+   * characters, using letters, numbers, dots, underscores, or hyphens.
+   */
+  name?: string;
+
+  /**
+   * If true, save changes made during the session back to the profile when the
+   * session ends.
+   */
+  save_changes?: boolean;
+}
+
+/**
+ * Initial browser window size in pixels with optional refresh rate. If omitted,
+ * image defaults apply (commonly 1024x768@60). Only specific viewport
+ * configurations are supported. The server will reject unsupported combinations.
+ * Supported resolutions are: 2560x1440@10, 1920x1080@25, 1920x1200@25,
+ * 1440x900@25, 1024x768@60, 1200x800@60 If refresh_rate is not provided, it will
+ * be automatically determined from the width and height if they match a supported
+ * configuration exactly. Note: Higher resolutions may affect the responsiveness of
+ * live view browser
+ */
+export interface BrowserViewport {
+  /**
+   * Browser window height in pixels.
+   */
+  height: number;
+
+  /**
+   * Browser window width in pixels.
+   */
+  width: number;
+
+  /**
+   * Display refresh rate in Hz. If omitted, automatically determined from width and
+   * height.
+   */
+  refresh_rate?: number;
+}
+
 export interface ErrorDetail {
   /**
    * Lower-level error code providing more specific detail

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.19.2'; // x-release-please-version
+export const VERSION = '0.21.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.19.2";
+export declare const VERSION = "0.21.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.19.2";
+export declare const VERSION = "0.21.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.19.2'; // x-release-please-version
+exports.VERSION = '0.21.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.19.2'; // x-release-please-version
+export const VERSION = '0.21.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map