@onkernel/sdk 0.22.0 → 0.24.0

package/src/resources/agents/index.ts

@@ -0,0 +1,18 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Agents } from './agents';
+export {
+  Auth,
+  type AgentAuthDiscoverResponse,
+  type AgentAuthInvocationResponse,
+  type AgentAuthSubmitResponse,
+  type AuthAgent,
+  type AuthAgentCreateRequest,
+  type AuthAgentInvocationCreateRequest,
+  type AuthAgentInvocationCreateResponse,
+  type DiscoveredField,
+  type ReauthResponse,
+  type AuthCreateParams,
+  type AuthListParams,
+  type AuthAgentsOffsetPagination,
+} from './auth/index';

package/src/resources/agents.ts

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

package/src/resources/browser-pools.ts

@@ -162,7 +162,7 @@ export interface BrowserPool {
   /**
    * Configuration used to create all browsers in this pool
    */
-  browser_pool_config: BrowserPoolRequest;
+  browser_pool_config: BrowserPool.BrowserPoolConfig;
 
   /**
    * Timestamp when the browser pool was created
@@ -175,118 +175,79 @@ export interface BrowserPool {
   name?: string;
 }
 
-/**
- * Request body for acquiring a browser from the pool.
- */
-export interface BrowserPoolAcquireRequest {
-  /**
-   * Maximum number of seconds to wait for a browser to be available. Defaults to the
-   * calculated time it would take to fill the pool at the currently configured fill
-   * rate.
-   */
-  acquire_timeout_seconds?: number;
-}
-
-/**
- * Request body for releasing a browser back to the pool.
- */
-export interface BrowserPoolReleaseRequest {
-  /**
-   * Browser session ID to release back to the pool
-   */
-  session_id: string;
-
-  /**
-   * Whether to reuse the browser instance or destroy it and create a new one.
-   * Defaults to true.
-   */
-  reuse?: boolean;
-}
-
-/**
- * Parameters for creating a browser pool. All browsers in the pool will be created
- * with the same configuration.
- */
-export interface BrowserPoolRequest {
-  /**
-   * Number of browsers to create in the pool
-   */
-  size: number;
-
-  /**
-   * List of browser extensions to load into the session. Provide each by id or name.
-   */
-  extensions?: Array<Shared.BrowserExtension>;
-
-  /**
-   * Percentage of the pool to fill per minute. Defaults to 10%.
-   */
-  fill_rate_per_minute?: number;
-
-  /**
-   * If true, launches the browser using a headless image. Defaults to false.
-   */
-  headless?: boolean;
-
-  /**
-   * If true, launches the browser in kiosk mode to hide address bar and tabs in live
-   * view.
-   */
-  kiosk_mode?: boolean;
-
-  /**
-   * Optional name for the browser pool. Must be unique within the organization.
-   */
-  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.
-   */
-  profile?: Shared.BrowserProfile;
-
-  /**
-   * Optional proxy to associate to the browser session. Must reference a proxy
-   * belonging to the caller's org.
-   */
-  proxy_id?: string;
-
-  /**
-   * If true, launches the browser in stealth mode to reduce detection by anti-bot
-   * mechanisms.
-   */
-  stealth?: boolean;
-
-  /**
-   * Default idle timeout in seconds for browsers acquired from this pool before they
-   * are destroyed. Defaults to 600 seconds if not specified
-   */
-  timeout_seconds?: 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;
-}
-
-/**
- * Parameters for updating a browser pool. All browsers in the pool will be created
- * with the same configuration.
- */
-export interface BrowserPoolUpdateRequest extends BrowserPoolRequest {
+export namespace BrowserPool {
   /**
-   * Whether to discard all idle browsers and rebuild the pool immediately. Defaults
-   * to true.
+   * Configuration used to create all browsers in this pool
    */
-  discard_all_idle?: boolean;
+  export interface BrowserPoolConfig {
+    /**
+     * Number of browsers to create in the pool
+     */
+    size: number;
+
+    /**
+     * List of browser extensions to load into the session. Provide each by id or name.
+     */
+    extensions?: Array<Shared.BrowserExtension>;
+
+    /**
+     * Percentage of the pool to fill per minute. Defaults to 10%.
+     */
+    fill_rate_per_minute?: number;
+
+    /**
+     * If true, launches the browser using a headless image. Defaults to false.
+     */
+    headless?: boolean;
+
+    /**
+     * If true, launches the browser in kiosk mode to hide address bar and tabs in live
+     * view.
+     */
+    kiosk_mode?: boolean;
+
+    /**
+     * Optional name for the browser pool. Must be unique within the organization.
+     */
+    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.
+     */
+    profile?: Shared.BrowserProfile;
+
+    /**
+     * Optional proxy to associate to the browser session. Must reference a proxy
+     * belonging to the caller's org.
+     */
+    proxy_id?: string;
+
+    /**
+     * If true, launches the browser in stealth mode to reduce detection by anti-bot
+     * mechanisms.
+     */
+    stealth?: boolean;
+
+    /**
+     * Default idle timeout in seconds for browsers acquired from this pool before they
+     * are destroyed. Defaults to 600 seconds if not specified
+     */
+    timeout_seconds?: number;
+
+    /**
+     * Initial browser window size in pixels with optional refresh rate. If omitted,
+     * image defaults apply (1920x1080@25). 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 type BrowserPoolListResponse = Array<BrowserPool>;
@@ -339,7 +300,8 @@ export interface BrowserPoolAcquireResponse {
   kiosk_mode?: boolean;
 
   /**
-   * Optional persistence configuration for the browser session.
+   * @deprecated DEPRECATED: Use timeout_seconds (up to 72 hours) and Profiles
+   * instead.
    */
   persistence?: BrowsersAPI.BrowserPersistence;
 
@@ -355,11 +317,11 @@ export interface BrowserPoolAcquireResponse {
 
   /**
    * 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
+   * image defaults apply (1920x1080@25). 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
    */
@@ -425,11 +387,11 @@ export interface BrowserPoolCreateParams {
 
   /**
    * 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
+   * image defaults apply (1920x1080@25). 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
    */
@@ -444,7 +406,7 @@ export interface BrowserPoolUpdateParams {
 
   /**
    * Whether to discard all idle browsers and rebuild the pool immediately. Defaults
-   * to true.
+   * to false.
    */
   discard_all_idle?: boolean;
 
@@ -501,11 +463,11 @@ export interface BrowserPoolUpdateParams {
 
   /**
    * 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
+   * image defaults apply (1920x1080@25). 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
    */
@@ -545,10 +507,6 @@ export interface BrowserPoolReleaseParams {
 export declare namespace BrowserPools {
   export {
     type BrowserPool as BrowserPool,
-    type BrowserPoolAcquireRequest as BrowserPoolAcquireRequest,
-    type BrowserPoolReleaseRequest as BrowserPoolReleaseRequest,
-    type BrowserPoolRequest as BrowserPoolRequest,
-    type BrowserPoolUpdateRequest as BrowserPoolUpdateRequest,
     type BrowserPoolListResponse as BrowserPoolListResponse,
     type BrowserPoolAcquireResponse as BrowserPoolAcquireResponse,
     type BrowserPoolCreateParams as BrowserPoolCreateParams,

package/src/resources/browsers/browsers.ts

@@ -127,14 +127,10 @@ export class Browsers extends APIResource {
   }
 
   /**
-   * Delete a persistent browser session by its persistent_id.
+   * DEPRECATED: Use DELETE /browsers/{id} instead. Delete a persistent browser
+   * session by its persistent_id.
    *
-   * @example
-   * ```ts
-   * await client.browsers.delete({
-   *   persistent_id: 'persistent_id',
-   * });
-   * ```
+   * @deprecated
    */
   delete(params: BrowserDeleteParams, options?: RequestOptions): APIPromise<void> {
     const { persistent_id } = params;
@@ -192,11 +188,12 @@ export class Browsers extends APIResource {
 export type BrowserListResponsesOffsetPagination = OffsetPagination<BrowserListResponse>;
 
 /**
- * Optional persistence configuration for the browser session.
+ * @deprecated DEPRECATED: Use timeout_seconds (up to 72 hours) and Profiles
+ * instead.
  */
 export interface BrowserPersistence {
   /**
-   * Unique identifier for the persistent browser session.
+   * DEPRECATED: Unique identifier for the persistent browser session.
    */
   id: string;
 }
@@ -279,7 +276,8 @@ export interface BrowserCreateResponse {
   kiosk_mode?: boolean;
 
   /**
-   * Optional persistence configuration for the browser session.
+   * @deprecated DEPRECATED: Use timeout_seconds (up to 72 hours) and Profiles
+   * instead.
    */
   persistence?: BrowserPersistence;
 
@@ -295,11 +293,11 @@ export interface 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
+   * image defaults apply (1920x1080@25). 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
    */
@@ -354,7 +352,8 @@ export interface BrowserRetrieveResponse {
   kiosk_mode?: boolean;
 
   /**
-   * Optional persistence configuration for the browser session.
+   * @deprecated DEPRECATED: Use timeout_seconds (up to 72 hours) and Profiles
+   * instead.
    */
   persistence?: BrowserPersistence;
 
@@ -370,11 +369,11 @@ export interface BrowserRetrieveResponse {
 
   /**
    * 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
+   * image defaults apply (1920x1080@25). 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
    */
@@ -429,7 +428,8 @@ export interface BrowserListResponse {
   kiosk_mode?: boolean;
 
   /**
-   * Optional persistence configuration for the browser session.
+   * @deprecated DEPRECATED: Use timeout_seconds (up to 72 hours) and Profiles
+   * instead.
    */
   persistence?: BrowserPersistence;
 
@@ -445,11 +445,11 @@ 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
+   * image defaults apply (1920x1080@25). 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
    */
@@ -480,7 +480,8 @@ export interface BrowserCreateParams {
   kiosk_mode?: boolean;
 
   /**
-   * Optional persistence configuration for the browser session.
+   * @deprecated DEPRECATED: Use timeout_seconds (up to 72 hours) and Profiles
+   * instead.
    */
   persistence?: BrowserPersistence;
 
@@ -505,21 +506,20 @@ export interface BrowserCreateParams {
 
   /**
    * The number of seconds of inactivity before the browser session is terminated.
-   * Only applicable to non-persistent browsers. Activity includes CDP connections
-   * and live view connections. Defaults to 60 seconds. Minimum allowed is 10
-   * seconds. Maximum allowed is 259200 (72 hours). We check for inactivity every 5
-   * seconds, so the actual timeout behavior you will see is +/- 5 seconds around the
-   * specified value.
+   * Activity includes CDP connections and live view connections. Defaults to 60
+   * seconds. Minimum allowed is 10 seconds. Maximum allowed is 259200 (72 hours). We
+   * check for inactivity every 5 seconds, so the actual timeout behavior you will
+   * see is +/- 5 seconds around the specified value.
    */
   timeout_seconds?: 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
+   * image defaults apply (1920x1080@25). 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
    */

package/src/resources/credentials.ts

@@ -0,0 +1,205 @@
+// 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 { OffsetPagination, type OffsetPaginationParams, PagePromise } from '../core/pagination';
+import { buildHeaders } from '../internal/headers';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class Credentials extends APIResource {
+  /**
+   * Create a new credential for storing login information. Values are encrypted at
+   * rest.
+   *
+   * @example
+   * ```ts
+   * const credential = await client.credentials.create({
+   *   domain: 'netflix.com',
+   *   name: 'my-netflix-login',
+   *   values: {
+   *     username: 'user@example.com',
+   *     password: 'mysecretpassword',
+   *   },
+   * });
+   * ```
+   */
+  create(body: CredentialCreateParams, options?: RequestOptions): APIPromise<Credential> {
+    return this._client.post('/credentials', { body, ...options });
+  }
+
+  /**
+   * Retrieve a credential by its ID. Credential values are not returned.
+   *
+   * @example
+   * ```ts
+   * const credential = await client.credentials.retrieve('id');
+   * ```
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<Credential> {
+    return this._client.get(path`/credentials/${id}`, options);
+  }
+
+  /**
+   * Update a credential's name or values. Values are encrypted at rest.
+   *
+   * @example
+   * ```ts
+   * const credential = await client.credentials.update('id');
+   * ```
+   */
+  update(id: string, body: CredentialUpdateParams, options?: RequestOptions): APIPromise<Credential> {
+    return this._client.patch(path`/credentials/${id}`, { body, ...options });
+  }
+
+  /**
+   * List credentials owned by the caller's organization. Credential values are not
+   * returned.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const credential of client.credentials.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: CredentialListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<CredentialsOffsetPagination, Credential> {
+    return this._client.getAPIList('/credentials', OffsetPagination<Credential>, { query, ...options });
+  }
+
+  /**
+   * Delete a credential by its ID.
+   *
+   * @example
+   * ```ts
+   * await client.credentials.delete('id');
+   * ```
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/credentials/${id}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export type CredentialsOffsetPagination = OffsetPagination<Credential>;
+
+/**
+ * Request to create a new credential
+ */
+export interface CreateCredentialRequest {
+  /**
+   * Target domain this credential is for
+   */
+  domain: string;
+
+  /**
+   * Unique name for the credential within the organization
+   */
+  name: string;
+
+  /**
+   * Field name to value mapping (e.g., username, password)
+   */
+  values: { [key: string]: string };
+}
+
+/**
+ * A stored credential for automatic re-authentication
+ */
+export interface Credential {
+  /**
+   * Unique identifier for the credential
+   */
+  id: string;
+
+  /**
+   * When the credential was created
+   */
+  created_at: string;
+
+  /**
+   * Target domain this credential is for
+   */
+  domain: string;
+
+  /**
+   * Unique name for the credential within the organization
+   */
+  name: string;
+
+  /**
+   * When the credential was last updated
+   */
+  updated_at: string;
+}
+
+/**
+ * Request to update an existing credential
+ */
+export interface UpdateCredentialRequest {
+  /**
+   * New name for the credential
+   */
+  name?: string;
+
+  /**
+   * Field name to value mapping (e.g., username, password). Replaces all existing
+   * values.
+   */
+  values?: { [key: string]: string };
+}
+
+export interface CredentialCreateParams {
+  /**
+   * Target domain this credential is for
+   */
+  domain: string;
+
+  /**
+   * Unique name for the credential within the organization
+   */
+  name: string;
+
+  /**
+   * Field name to value mapping (e.g., username, password)
+   */
+  values: { [key: string]: string };
+}
+
+export interface CredentialUpdateParams {
+  /**
+   * New name for the credential
+   */
+  name?: string;
+
+  /**
+   * Field name to value mapping (e.g., username, password). Replaces all existing
+   * values.
+   */
+  values?: { [key: string]: string };
+}
+
+export interface CredentialListParams extends OffsetPaginationParams {
+  /**
+   * Filter by domain
+   */
+  domain?: string;
+}
+
+export declare namespace Credentials {
+  export {
+    type CreateCredentialRequest as CreateCredentialRequest,
+    type Credential as Credential,
+    type UpdateCredentialRequest as UpdateCredentialRequest,
+    type CredentialsOffsetPagination as CredentialsOffsetPagination,
+    type CredentialCreateParams as CredentialCreateParams,
+    type CredentialUpdateParams as CredentialUpdateParams,
+    type CredentialListParams as CredentialListParams,
+  };
+}