@roxybrowser/openapi 1.0.5-beta.1 → 1.0.8

package/lib/types.d.ts

@@ -27,25 +27,62 @@ export interface WorkspaceListResponse {
 }
 /** Browser open result (single browser) */
 export interface BrowserOpenResult {
+    /**
+     * WebSocket CDP endpoint
+     */
     ws: string;
-    http: string;
-    coreVersion: string;
-    driver: string;
-    sortNum: number;
-    windowName: string;
-    windowRemark: string;
-    pid: number;
+    http: string; /**
+                  * HTTP endpoint
+                  */
+    coreVersion: string; /**
+                         * Browser core version
+                         */
+    driver: string; /**
+                    * WebDriver path
+                    */
+    sortNum: number; /**
+                     * Window sort number
+                     */
+    windowName: string; /**
+                        * Window name
+                        */
+    windowRemark: string; /**
+                          * Window remark
+                          */
+    pid: number; /**
+                 * Process ID
+                 */
+    /**
+     * Browser directory ID
+     */
     dirId?: string;
 }
 /** Browser list item */
 export interface BrowserListItem {
-    dirId: string;
-    workspaceId: number;
-    projectId: number;
-    windowName: string;
-    windowRemark: string;
-    sortNum: number;
-    os: string;
+    dirId: string; /**
+                   * Browser directory ID
+                   */
+    workspaceId: number; /**
+                         * Workspace ID
+                         */
+    projectId: number; /**
+                       * Project ID
+                       */
+    windowName: string; /**
+                        * Window name
+                        */
+    windowRemark: string; /**
+                          * Window remark
+                          */
+    sortNum: number; /**
+                     * Window sort number
+                     */
+    os: string; /**
+                * Operating system
+                */
+    /**
+     * Browser status
+     */
     status: string;
 }
 /** Paginated browser list response */
@@ -56,23 +93,48 @@ export interface BrowserListResponse {
 /** Browser list query parameters */
 export interface BrowserListParams {
     workspaceId: number;
-    dirIds?: string;
-    windowName?: string;
-    sortNums?: string;
-    os?: string;
-    projectIds?: string;
-    windowRemark?: string;
-    page_index?: number;
+    dirIds?: string; /**
+                     * Comma-separated browser IDs
+                     */
+    windowName?: string; /**
+                         * Browser window name
+                         */
+    sortNums?: string; /**
+                       * Comma-separated sort numbers
+                       */
+    os?: string; /**
+                 * Operating system
+                 */
+    projectIds?: string; /**
+                         * Comma-separated project IDs
+                         */
+    windowRemark?: string; /**
+                           * Window remark
+                           */
+    page_index?: number; /**
+                         * Page index (default: 1)
+                         */
+    /**
+     * Page size (default: 15)
+     */
     page_size?: number;
 }
 /** Browser open parameters */
 export interface BrowserOpenParams {
     workspaceId: number;
-    dirId: string;
+    dirId: string; /**
+                   * Browser directory ID
+                   */
+    /**
+     * Browser startup arguments
+     */
     args?: string[];
 }
 /** Browser close parameters */
 export interface BrowserCloseParams {
+    /**
+     * Browser directory ID
+     */
     dirId: string;
 }
 /** Workspace list tool response */
@@ -83,7 +145,9 @@ export interface WorkspaceListToolResponse {
 /** Browser list tool parameters */
 export interface BrowserListToolParams {
     workspaceId: number;
-    projectIds?: string;
+    projectIds?: string; /**
+                         * Comma-separated project IDs
+                         */
     windowName?: string;
     pageIndex?: number;
     pageSize?: number;
@@ -97,15 +161,24 @@ export interface BrowserListToolResponse {
 /** Browser open tool parameters */
 export interface BrowserOpenToolParams {
     workspaceId: number;
-    dirIds: string[];
+    dirIds: string[]; /**
+                      * Array of browser directory IDs
+                      */
+    /**
+     * Optional browser startup arguments
+     */
     args?: string[];
 }
 /** Browser open tool response */
 export interface BrowserOpenToolResponse {
     results: {
         dirId: string;
-        ws: string;
-        http: string;
+        ws: string; /**
+                    * CDP WebSocket endpoint
+                    */
+        http: string; /**
+                      * HTTP endpoint
+                      */
         pid: number;
         success: boolean;
         error?: string;
@@ -116,6 +189,9 @@ export interface BrowserOpenToolResponse {
 }
 /** Browser close tool parameters */
 export interface BrowserCloseToolParams {
+    /**
+     * Array of browser directory IDs
+     */
     dirIds: string[];
 }
 /** Browser close tool response */
@@ -131,7 +207,12 @@ export interface BrowserCloseToolResponse {
 }
 /** Browser delete tool parameters */
 export interface BrowserDeleteToolParams {
-    workspaceId: number;
+    workspaceId: number; /**
+                         * Workspace ID
+                         */
+    /**
+     * Array of browser directory IDs to delete
+     */
     dirIds: string[];
 }
 /** Browser delete tool response */
@@ -147,8 +228,15 @@ export interface BrowserDeleteToolResponse {
 }
 /** RoxyBrowser client configuration */
 export interface RoxyClientConfig {
-    apiHost: string;
-    apiKey: string;
+    apiHost: string; /**
+                     * RoxyBrowser API host (default: http://127.0.0.1:50000)
+                     */
+    apiKey: string; /**
+                    * RoxyBrowser API key
+                    */
+    /**
+     * Request timeout in milliseconds (default: 30000)
+     */
     timeout?: number;
 }
 /** Browser operating system types */
@@ -161,136 +249,409 @@ export declare const LATEST_CORE_VERSION: CoreVersion;
 export type SearchEngine = 'Google' | 'Microsoft Bing' | 'Yahoo' | 'Yandex' | 'DuckDuckGo';
 /** Window platform information */
 export interface WindowPlatformInfo {
-    platformUrl?: string;
-    platformUserName?: string;
-    platformPassword?: string;
-    platformEfa?: string;
+    platformUrl?: string; /**
+                          * Business platform URL
+                          */
+    platformUserName?: string; /**
+                               * Platform account
+                               */
+    platformPassword?: string; /**
+                               * Platform password
+                               */
+    platformEfa?: string; /**
+                          * EFA value
+                          */
+    /**
+     * Platform remarks
+     */
     platformRemarks?: string;
 }
 /** Proxy configuration details */
 export interface ProxyInfo {
-    proxyMethod?: 'custom' | 'choose' | 'api';
-    proxyCategory?: 'noproxy' | 'HTTP' | 'HTTPS' | 'SOCKS5' | 'SSH';
-    ipType?: 'IPV4' | 'IPV6';
-    protocol?: 'HTTP' | 'HTTPS' | 'SOCKS5';
-    host?: string;
-    port?: string;
-    proxyUserName?: string;
-    proxyPassword?: string;
-    refreshUrl?: string;
+    proxyMethod?: 'custom' | 'choose' | 'api'; /**
+                                               * Proxy method
+                                               */
+    proxyCategory?: 'noproxy' | 'HTTP' | 'HTTPS' | 'SOCKS5' | 'SSH'; /**
+                                                                     * Proxy type
+                                                                     */
+    ipType?: 'IPV4' | 'IPV6'; /**
+                              * Network protocol
+                              */
+    protocol?: 'HTTP' | 'HTTPS' | 'SOCKS5'; /**
+                                            * Proxy protocol
+                                            */
+    host?: string; /**
+                   * Proxy host
+                   */
+    port?: string; /**
+                   * Proxy port
+                   */
+    proxyUserName?: string; /**
+                            * Proxy username
+                            */
+    proxyPassword?: string; /**
+                            * Proxy password
+                            */
+    refreshUrl?: string; /**
+                         * Refresh URL
+                         */
+    /**
+     * IP query channel
+     */
     checkChannel?: 'IPRust.io' | 'IP-API' | 'IP123.in';
 }
 /** Fingerprint configuration */
 export interface FingerInfo {
-    isLanguageBaseIp?: boolean;
-    language?: string;
-    isDisplayLanguageBaseIp?: boolean;
+    /**
+     * Language settings
+     */
+    isLanguageBaseIp?: boolean; /**
+                                * Follow IP matching for browser language
+                                */
+    language?: string; /**
+                       * Custom browser language
+                       */
+    isDisplayLanguageBaseIp?: boolean; /**
+                                       * Follow IP matching for display language
+                                       */
+    /**
+     * Custom display language
+     */
     displayLanguage?: string;
-    isTimeZone?: boolean;
-    timeZone?: string;
-    position?: 0 | 1 | 2;
-    isPositionBaseIp?: boolean;
-    longitude?: string;
-    latitude?: string;
+    /**
+     * Location and timezone
+     */
+    isTimeZone?: boolean; /**
+                          * Follow IP matching for timezone
+                          */
+    timeZone?: string; /**
+                       * Custom timezone
+                       */
+    position?: 0 | 1 | 2; /**
+                          * Geolocation prompt: 0=ask, 1=allow, 2=deny
+                          */
+    isPositionBaseIp?: boolean; /**
+                                * Follow IP matching for geolocation
+                                */
+    longitude?: string; /**
+                        * Custom longitude
+                        */
+    latitude?: string; /**
+                       * Custom latitude
+                       */
+    /**
+     * Precision in meters
+     */
     precisionPos?: string;
-    forbidAudio?: boolean;
-    forbidImage?: boolean;
+    /**
+     * Media settings
+     */
+    forbidAudio?: boolean; /**
+                           * Enable/disable sound
+                           */
+    forbidImage?: boolean; /**
+                           * Enable/disable image loading
+                           */
+    /**
+     * Enable/disable video playback
+     */
     forbidMedia?: boolean;
-    openWidth?: string;
-    openHeight?: string;
-    openBookmarks?: boolean;
-    positionSwitch?: boolean;
-    windowRatioPosition?: string;
+    /**
+     * Window settings
+     */
+    openWidth?: string; /**
+                        * Window width
+                        */
+    openHeight?: string; /**
+                         * Window height
+                         */
+    openBookmarks?: boolean; /**
+                             * Enable bookmarks
+                             */
+    positionSwitch?: boolean; /**
+                              * Window position switch
+                              */
+    windowRatioPosition?: string; /**
+                                  * Window position ratio
+                                  */
+    /**
+     * Show window name in title bar
+     */
     isDisplayName?: boolean;
-    syncBookmark?: boolean;
-    syncHistory?: boolean;
-    syncTab?: boolean;
-    syncCookie?: boolean;
-    syncExtensions?: boolean;
-    syncPassword?: boolean;
-    syncIndexedDb?: boolean;
+    /**
+     * Sync settings
+     */
+    syncBookmark?: boolean; /**
+                            * Sync bookmarks
+                            */
+    syncHistory?: boolean; /**
+                           * Sync history
+                           */
+    syncTab?: boolean; /**
+                       * Sync tabs
+                       */
+    syncCookie?: boolean; /**
+                          * Sync cookies
+                          */
+    syncExtensions?: boolean; /**
+                              * Sync extensions
+                              */
+    syncPassword?: boolean; /**
+                            * Sync saved passwords
+                            */
+    syncIndexedDb?: boolean; /**
+                             * Sync IndexedDB
+                             */
+    /**
+     * Sync LocalStorage
+     */
     syncLocalStorage?: boolean;
-    clearCacheFile?: boolean;
-    clearCookie?: boolean;
+    /**
+     * Cleanup settings
+     */
+    clearCacheFile?: boolean; /**
+                              * Clear cache files on startup
+                              */
+    clearCookie?: boolean; /**
+                           * Clear cookies on startup
+                           */
+    /**
+     * Clear LocalStorage on startup
+     */
     clearLocalStorage?: boolean;
-    randomFingerprint?: boolean;
-    forbidSavePassword?: boolean;
-    stopOpenNet?: boolean;
-    stopOpenIP?: boolean;
-    stopOpenPosition?: boolean;
+    /**
+     * Advanced settings
+     */
+    randomFingerprint?: boolean; /**
+                                 * Generate random fingerprint
+                                 */
+    forbidSavePassword?: boolean; /**
+                                  * Disable password save prompts
+                                  */
+    stopOpenNet?: boolean; /**
+                           * Stop opening if network fails
+                           */
+    stopOpenIP?: boolean; /**
+                          * Stop opening if IP changes
+                          */
+    stopOpenPosition?: boolean; /**
+                                * Stop opening if IP location changes
+                                */
+    /**
+     * Open workbench: 0=close, 1=open, 2=follow app
+     */
     openWorkbench?: 0 | 1 | 2;
-    resolutionType?: boolean;
-    resolutionX?: string;
-    resolutionY?: string;
+    /**
+     * Display settings
+     */
+    resolutionType?: boolean; /**
+                              * Custom resolution vs follow system
+                              */
+    resolutionX?: string; /**
+                          * Custom resolution width
+                          */
+    resolutionY?: string; /**
+                          * Custom resolution height
+                          */
+    /**
+     * Random fonts vs system fonts
+     */
     fontType?: boolean;
-    webRTC?: 0 | 1 | 2;
-    webGL?: boolean;
-    webGLInfo?: boolean;
-    webGLManufacturer?: string;
-    webGLRender?: string;
-    webGpu?: 'webgl' | 'real' | 'block';
-    canvas?: boolean;
-    audioContext?: boolean;
-    speechVoices?: boolean;
-    doNotTrack?: boolean;
-    clientRects?: boolean;
-    deviceInfo?: boolean;
-    deviceNameSwitch?: boolean;
-    macInfo?: boolean;
-    hardwareConcurrent?: string;
-    deviceMemory?: string;
-    disableSsl?: boolean;
-    disableSslList?: string[];
-    portScanProtect?: boolean;
-    portScanList?: string;
-    useGpu?: boolean;
-    sandboxPermission?: boolean;
+    /**
+     * Browser fingerprint settings
+     */
+    webRTC?: 0 | 1 | 2; /**
+                        * WebRTC: 0=replace, 1=real, 2=disable
+                        */
+    webGL?: boolean; /**
+                     * WebGL: random vs real
+                     */
+    webGLInfo?: boolean; /**
+                         * WebGL info: custom vs real
+                         */
+    webGLManufacturer?: string; /**
+                                * Custom WebGL manufacturer
+                                */
+    webGLRender?: string; /**
+                          * Custom WebGL renderer
+                          */
+    webGpu?: 'webgl' | 'real' | 'block'; /**
+                                         * WebGPU setting
+                                         */
+    canvas?: boolean; /**
+                      * Canvas: random vs real
+                      */
+    audioContext?: boolean; /**
+                            * AudioContext: random vs real
+                            */
+    speechVoices?: boolean; /**
+                            * Speech Voices: random vs real
+                            */
+    doNotTrack?: boolean; /**
+                          * Enable Do Not Track
+                          */
+    clientRects?: boolean; /**
+                           * ClientRects: random vs real
+                           */
+    deviceInfo?: boolean; /**
+                          * Media devices: random vs real
+                          */
+    deviceNameSwitch?: boolean; /**
+                                * Device names: random vs real
+                                */
+    macInfo?: boolean; /**
+                       * MAC address: custom vs real
+                       */
+    hardwareConcurrent?: string; /**
+                                 * Hardware concurrency
+                                 */
+    deviceMemory?: string; /**
+                           * Device memory
+                           */
+    disableSsl?: boolean; /**
+                          * SSL fingerprint settings
+                          */
+    disableSslList?: string[]; /**
+                               * SSL feature list
+                               */
+    portScanProtect?: boolean; /**
+                               * Port scan protection
+                               */
+    portScanList?: string; /**
+                           * Port scan whitelist
+                           */
+    useGpu?: boolean; /**
+                      * Use GPU acceleration
+                      */
+    sandboxPermission?: boolean; /**
+                                 * Disable sandbox
+                                 */
+    /**
+     * Browser startup parameters
+     */
     startupParam?: string;
 }
 /** Complete browser creation configuration */
 export interface BrowserCreateConfig {
-    workspaceId: number;
-    windowName?: string;
-    coreVersion?: CoreVersion;
-    os?: BrowserOS;
-    osVersion?: string;
-    userAgent?: string;
-    cookie?: unknown[];
-    searchEngine?: SearchEngine;
-    labelIds?: number[];
-    windowPlatformList?: WindowPlatformInfo[];
-    defaultOpenUrl?: string[];
-    windowRemark?: string;
-    projectId?: number;
-    proxyInfo?: ProxyInfo;
+    workspaceId: number; /**
+                         * Required: Workspace ID
+                         */
+    windowName?: string; /**
+                         * Window name
+                         */
+    coreVersion?: CoreVersion; /**
+                               * Browser core version
+                               */
+    os?: BrowserOS; /**
+                    * Operating system
+                    */
+    osVersion?: string; /**
+                        * OS version
+                        */
+    userAgent?: string; /**
+                        * Custom user agent
+                        */
+    cookie?: unknown[]; /**
+                        * Cookie list
+                        */
+    searchEngine?: SearchEngine; /**
+                                 * Default search engine
+                                 */
+    labelIds?: number[]; /**
+                         * Label IDs
+                         */
+    windowPlatformList?: WindowPlatformInfo[]; /**
+                                               * Platform account info
+                                               */
+    defaultOpenUrl?: string[]; /**
+                               * Default URLs to open
+                               */
+    windowRemark?: string; /**
+                           * Window remarks
+                           */
+    projectId?: number; /**
+                        * Project ID
+                        */
+    proxyInfo?: ProxyInfo; /**
+                           * Proxy configuration
+                           */
+    /**
+     * Fingerprint configuration
+     */
     fingerInfo?: FingerInfo;
 }
 /** Simple browser creation parameters - for most common use cases */
 export interface BrowserCreateSimpleParams {
-    workspaceId: number;
-    windowName?: string;
-    projectId?: number;
-    windowRemark?: string;
-    proxyHost?: string;
-    proxyPort?: string;
-    proxyUserName?: string;
-    proxyPassword?: string;
+    workspaceId: number; /**
+                         * Required: Workspace ID
+                         */
+    windowName?: string; /**
+                         * Window name
+                         */
+    projectId?: number; /**
+                        * Project ID
+                        */
+    windowRemark?: string; /**
+                           * Window remarks
+                           */
+    proxyHost?: string; /**
+                        * Simple proxy host
+                        */
+    proxyPort?: string; /**
+                        * Simple proxy port
+                        */
+    proxyUserName?: string; /**
+                            * Simple proxy username
+                            */
+    proxyPassword?: string; /**
+                            * Simple proxy password
+                            */
+    /**
+     * Simple proxy type
+     */
     proxyType?: 'HTTP' | 'HTTPS' | 'SOCKS5';
 }
 /** Standard browser creation parameters - covers 80% of use cases */
 export interface BrowserCreateStandardParams {
-    workspaceId: number;
-    windowName?: string;
-    projectId?: number;
-    windowRemark?: string;
-    os?: BrowserOS;
-    osVersion?: string;
-    coreVersion?: CoreVersion;
-    proxyInfo?: ProxyInfo;
-    openWidth?: string;
-    openHeight?: string;
-    language?: string;
-    timeZone?: string;
+    workspaceId: number; /**
+                         * Required: Workspace ID
+                         */
+    windowName?: string; /**
+                         * Window name
+                         */
+    projectId?: number; /**
+                        * Project ID
+                        */
+    windowRemark?: string; /**
+                           * Window remarks
+                           */
+    os?: BrowserOS; /**
+                    * Operating system
+                    */
+    osVersion?: string; /**
+                        * OS version
+                        */
+    coreVersion?: CoreVersion; /**
+                               * Browser core version
+                               */
+    proxyInfo?: ProxyInfo; /**
+                           * Complete proxy configuration
+                           */
+    openWidth?: string; /**
+                        * Window width
+                        */
+    openHeight?: string; /**
+                         * Window height
+                         */
+    language?: string; /**
+                       * Browser language
+                       */
+    timeZone?: string; /**
+                       * Timezone
+                       */
+    /**
+     * Default URLs
+     */
     defaultOpenUrl?: string[];
 }
 /** Advanced browser creation parameters - full control */
@@ -298,16 +659,34 @@ export interface BrowserCreateAdvancedParams extends BrowserCreateConfig {
 }
 /** Browser creation result */
 export interface BrowserCreateResult {
-    dirId: string;
-    windowName: string;
-    success: boolean;
+    dirId: string; /**
+                   * Browser directory ID
+                   */
+    windowName: string; /**
+                        * Window name
+                        */
+    success: boolean; /**
+                      * Creation success
+                      */
+    /**
+     * Error message if failed
+     */
     error?: string;
 }
 /** Batch browser creation result */
 export interface BrowserCreateBatchResult {
-    results: BrowserCreateResult[];
-    successCount: number;
-    failureCount: number;
+    results: BrowserCreateResult[]; /**
+                                    * Individual results
+                                    */
+    successCount: number; /**
+                          * Number of successful creations
+                          */
+    failureCount: number; /**
+                          * Number of failed creations
+                          */
+    /**
+     * Total attempts
+     */
     total: number;
 }
 /** Simple browser creation tool response */
@@ -416,19 +795,38 @@ export declare class BrowserCreationError extends Error {
 }
 /** Account item */
 export interface AccountItem {
-    id: number;
-    platformUrl: string;
-    platformUserName: string;
-    platformPassword: string;
-    platformEfa: string;
+    id: number; /**
+                * Account ID
+                */
+    platformUrl: string; /**
+                         * Business platform URL
+                         */
+    platformUserName: string; /**
+                              * Account username
+                              */
+    platformPassword: string; /**
+                              * Account password
+                              */
+    platformEfa: string; /**
+                         * Account EFA
+                         */
     platformCookies: Array<{
         name: string;
         value: string;
         domain: string;
     }>;
-    platformName: string;
-    platformRemarks: string;
-    createTime: string;
+    platformName: string; /**
+                          * Platform name
+                          */
+    platformRemarks: string; /**
+                             * Platform remarks
+                             */
+    createTime: string; /**
+                        * Create time
+                        */
+    /**
+     * Update time
+     */
     updateTime: string;
 }
 /** Paginated account list response */
@@ -443,10 +841,76 @@ export interface AccountListParams {
     page_index?: number;
     page_size?: number;
 }
+/** Account create parameters */
+export interface AccountCreateParams {
+    workspaceId: number;
+    /**
+     * Business platform URL (required)
+     */
+    platformUrl: string;
+    /**
+     * Account username (required)
+     */
+    platformUserName: string;
+    /**
+     * Account password (required)
+     */
+    platformPassword: string;
+    /**
+     * Account EFA (optional)
+     */
+    platformEfa?: string;
+    /**
+     * Account cookies (optional)
+     */
+    platformCookies?: Array<{
+        name: string;
+        value: string;
+        domain: string;
+    }>;
+    /**
+     * Platform name (optional)
+     */
+    platformName?: string;
+    /**
+     * Platform remarks/notes (optional)
+     */
+    platformRemarks?: string;
+}
+/** Account modify parameters (same as create but with id) */
+export interface AccountModifyParams extends AccountCreateParams {
+    /**
+     * Account ID (required for modify)
+     */
+    id: number;
+}
+/** Account delete parameters */
+export interface AccountDeleteParams {
+    workspaceId: number;
+    /**
+     * Array of account IDs to delete
+     */
+    ids: number[];
+}
+/** Batch create account parameters */
+export interface AccountBatchCreateParams {
+    workspaceId: number;
+    /**
+     * Array of account configurations
+     */
+    accountList: AccountCreateParams[];
+}
 /** Label item */
 export interface LabelItem {
-    id: number;
-    color: string;
+    id: number; /**
+                * Label ID
+                */
+    color: string; /**
+                   * Label color
+                   */
+    /**
+     * Label name
+     */
     name: string;
 }
 /** Label list response */
@@ -455,14 +919,33 @@ export interface LabelListResponse {
 }
 /** Connection info item for opened browser */
 export interface ConnectionInfoItem {
-    ws: string;
-    http: string;
-    coreVersion: string;
-    driver: string;
-    sortNum: number;
-    windowName: string;
-    windowRemark: string;
-    pid: number;
+    ws: string; /**
+                * WebSocket endpoint for automation tools
+                */
+    http: string; /**
+                  * HTTP endpoint for automation tools
+                  */
+    coreVersion: string; /**
+                         * Core version
+                         */
+    driver: string; /**
+                    * WebDriver path for automation tools
+                    */
+    sortNum: number; /**
+                     * Window sort number
+                     */
+    windowName: string; /**
+                        * Window name
+                        */
+    windowRemark: string; /**
+                          * Window remark
+                          */
+    pid: number; /**
+                 * Process ID
+                 */
+    /**
+     * Browser directory ID
+     */
     dirId: string;
 }
 /** Connection info response */
@@ -471,20 +954,242 @@ export interface ConnectionInfoResponse {
 }
 /** Browser update parameters (same as create but with dirId) */
 export interface BrowserUpdateParams extends BrowserCreateConfig {
+    /**
+     * Browser directory ID (required for update)
+     */
     dirId: string;
 }
 /** Local cache clear parameters */
 export interface ClearLocalCacheParams {
+    /**
+     * Array of browser directory IDs
+     */
     dirIds: string[];
 }
 /** Server cache clear parameters */
 export interface ClearServerCacheParams {
     workspaceId: number;
+    /**
+     * Array of browser directory IDs
+     */
     dirIds: string[];
 }
 /** Random fingerprint parameters */
 export interface RandomFingerprintParams {
     workspaceId: number;
+    /**
+     * Browser directory ID
+     */
     dirId: string;
 }
+/** Proxy list item */
+export interface ProxyListItem {
+    id?: number;
+    /**
+     * Proxy check status: 0=未检测, 1=检测成功, 2=检测失败
+     */
+    checkStatus?: number;
+    /**
+     * IP detection channel
+     */
+    checkChannel?: string;
+    /**
+     * IP detection channel value
+     */
+    checkChannelValue?: string;
+    /**
+     * Last detected IP address
+     */
+    lastIp?: string;
+    /**
+     * Last detected country
+     */
+    lastCountry?: string;
+    /**
+     * Last detected state/region
+     */
+    lastState?: string;
+    /**
+     * Last detected city
+     */
+    lastCity?: string;
+    /**
+     * IP type: IPV4 or IPV6
+     */
+    ipType?: string;
+    /**
+     * Proxy protocol: HTTP, HTTPS, SOCKS5, SSH
+     */
+    protocol?: string;
+    /**
+     * Proxy host/IP address
+     */
+    host?: string;
+    /**
+     * Proxy port
+     */
+    port?: string;
+    /**
+     * Proxy username
+     */
+    proxyUserName?: string;
+    /**
+     * Proxy password
+     */
+    proxyPassword?: string;
+    /**
+     * Refresh URL for dynamic proxies
+     */
+    refreshUrl?: string;
+    /**
+     * Proxy remark/notes
+     */
+    remark?: string;
+    /**
+     * Last check time
+     */
+    checkTime?: string;
+    /**
+     * Create time
+     */
+    createTime?: string;
+    /**
+     * Update time
+     */
+    updateTime?: string;
+    /**
+     * Timezone
+     */
+    timezone?: string;
+    /**
+     * Error information if check failed
+     */
+    error?: any;
+}
+/** Paginated proxy list response */
+export interface ProxyListResponse {
+    total: number;
+    rows: ProxyListItem[];
+}
+/** Proxy list query parameters */
+export interface ProxyListParams {
+    workspaceId: number;
+    id?: number;
+    page_index?: number;
+    page_size?: number;
+    [key: string]: any;
+}
+/** Proxy create parameters */
+export interface ProxyCreateParams {
+    workspaceId: number;
+    /**
+     * Proxy protocol: HTTP, HTTPS, SOCKS5, SSH
+     */
+    protocol?: string;
+    /**
+     * Proxy host/IP address
+     */
+    host?: string;
+    /**
+     * Proxy port
+     */
+    port?: string;
+    /**
+     * Proxy username
+     */
+    proxyUserName?: string;
+    /**
+     * Proxy password
+     */
+    proxyPassword?: string;
+    /**
+     * IP type: IPV4 or IPV6
+     */
+    ipType?: string;
+    /**
+     * IP detection channel: IPRust.io, IP-API, IP123.in
+     */
+    checkChannel?: string;
+    /**
+     * Refresh URL for dynamic proxies
+     */
+    refreshUrl?: string;
+    /**
+     * Proxy remark/notes
+     */
+    remark?: string;
+    /**
+     * Proxy category (same as protocol)
+     */
+    proxyCategory?: string;
+    [key: string]: any;
+}
+/** Proxy modify parameters (same as create but with id) */
+export interface ProxyModifyParams extends ProxyCreateParams {
+    /**
+     * Proxy ID (required for modify)
+     */
+    id: number;
+}
+/** Proxy detect parameters */
+export interface ProxyDetectParams {
+    workspaceId: number;
+    /**
+     * Proxy ID to detect
+     */
+    id: number;
+}
+/** Proxy delete parameters */
+export interface ProxyDeleteParams {
+    workspaceId: number;
+    /**
+     * Array of proxy IDs to delete
+     */
+    ids: number[];
+}
+/** Batch create proxy parameters */
+export interface ProxyBatchCreateParams {
+    workspaceId: number;
+    /**
+     * Default check channel for all proxies
+     */
+    checkChannel?: string;
+    /**
+     * Array of proxy configurations
+     */
+    proxyList: ProxyCreateParams[];
+}
+/** Detect channel item */
+export interface DetectChannelItem {
+    label: string;
+    value: string;
+}
+/** Detect channel response */
+export interface DetectChannelResponse {
+    checkChannel: DetectChannelItem[];
+}
+export interface BoughtProxyListItem {
+    id: number;
+    orderNo: string;
+    checkStatus: number;
+    proxyCheckChannel: string;
+    checkChannelValue: string;
+    lastIp: string;
+    lastCountry: string;
+    lastState: string;
+    lastCity: string;
+    proxyProviderName: string;
+    providerType: string;
+    ipType: string;
+    protocol: string;
+    host: string;
+    port: string;
+    proxyUserName: string;
+    proxyPassword: string;
+    remark: string;
+    checkTime: string;
+    createTime: string;
+    updateTime: string;
+    expireDate: string;
+}
 //# sourceMappingURL=types.d.ts.map