/** * kameleo-local-api * You can use the following API endpoints to communicate with the local running Kameleo programmatically. * * The version of the OpenAPI document: 4.4.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import * as runtime from "../runtime"; import type { BrowserSettings, CreateProfileRequest, ExportProfileRequest, ImportProfileRequest, ProfileLifetimeState, ProfilePreview, ProfileResponse, StatusResponse, UpdateProfileRequest } from "../models/index"; export interface CreateProfileOperationRequest { createProfileRequest: CreateProfileRequest; } export interface DeleteProfileRequest { profileId: string; } export interface DuplicateProfileRequest { profileId: string; } export interface ExportProfileOperationRequest { profileId: string; exportProfileRequest: ExportProfileRequest; } export interface GetProfileStatusRequest { profileId: string; } export interface ImportProfileOperationRequest { importProfileRequest?: ImportProfileRequest; } export interface ListProfilesRequest { lifetimeState?: ProfileLifetimeState; } export interface ReadProfileRequest { profileId: string; } export interface StartProfileRequest { profileId: string; browserSettings?: BrowserSettings; } export interface StopProfileRequest { profileId: string; } export interface UpdateProfileOperationRequest { profileId: string; updateProfileRequest: UpdateProfileRequest; } export interface UpgradeProfileKernelRequest { profileId: string; } /** * */ export declare class ProfileApi extends runtime.BaseAPI { /** * Create a new profile based on a selected fingerprint. Supply the required configuration in the request body, then receive the newly created profile’s full details. */ createProfileRaw(requestParameters: CreateProfileOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Create a new profile based on a selected fingerprint. Supply the required configuration in the request body, then receive the newly created profile’s full details. */ createProfile(createProfileRequest: CreateProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Permanently delete a profile from your workspace. */ deleteProfileRaw(requestParameters: DeleteProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Permanently delete a profile from your workspace. */ deleteProfile(profileId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Duplicate an existing profile by creating an exact copy with a new unique identifier. Use this endpoint to clone a profile while preserving all its configuration details and data. */ duplicateProfileRaw(requestParameters: DuplicateProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Duplicate an existing profile by creating an exact copy with a new unique identifier. Use this endpoint to clone a profile while preserving all its configuration details and data. */ duplicateProfile(profileId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Export a profile to a .kameleo file by providing the target file path in the request body. Use this to back up all profile attributes — including settings, browsing data, cookies, history, bookmarks, and extensions — for later restoration or migration. */ exportProfileRaw(requestParameters: ExportProfileOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Export a profile to a .kameleo file by providing the target file path in the request body. Use this to back up all profile attributes — including settings, browsing data, cookies, history, bookmarks, and extensions — for later restoration or migration. */ exportProfile(profileId: string, exportProfileRequest: ExportProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Check the current status of a profile, including its lifecycle and persistence states. */ getProfileStatusRaw(requestParameters: GetProfileStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Check the current status of a profile, including its lifecycle and persistence states. */ getProfileStatus(profileId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Imports a profile from a .kameleo file, effectively recreating the profile with all its attributes, including settings, browsing data, cookies, history, bookmarks, and any installed extensions/addons. If the profile is already loaded, the import process will fail. */ importProfileRaw(requestParameters: ImportProfileOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Imports a profile from a .kameleo file, effectively recreating the profile with all its attributes, including settings, browsing data, cookies, history, bookmarks, and any installed extensions/addons. If the profile is already loaded, the import process will fail. */ importProfile(importProfileRequest?: ImportProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Retrieve a list of all profiles loaded in your workspace. Use this endpoint to view a preview of each profile so you can quickly assess available profiles. */ listProfilesRaw(requestParameters: ListProfilesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>>; /** * Retrieve a list of all profiles loaded in your workspace. Use this endpoint to view a preview of each profile so you can quickly assess available profiles. */ listProfiles(lifetimeState?: ProfileLifetimeState, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Gets the profile with the specified GUID from the current workspace. On startup, Kameleo will automatically scan and load profiles stored in your workspace folder on startup. */ readProfileRaw(requestParameters: ReadProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Gets the profile with the specified GUID from the current workspace. On startup, Kameleo will automatically scan and load profiles stored in your workspace folder on startup. */ readProfile(profileId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Starts the selected profile by transitioning its status to \'starting\', launching the kernel (Chroma or Junglefox) associated with the profile, and then changing its status to \'running\'. If there is an error during start-up, it will be \'terminated\'. Note that the required kernel might not be available locally, so it may be downloaded during the profile start. Optional command line arguments or settings can be passed to the browser engines. */ startProfileRaw(requestParameters: StartProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Starts the selected profile by transitioning its status to \'starting\', launching the kernel (Chroma or Junglefox) associated with the profile, and then changing its status to \'running\'. If there is an error during start-up, it will be \'terminated\'. Note that the required kernel might not be available locally, so it may be downloaded during the profile start. Optional command line arguments or settings can be passed to the browser engines. */ startProfile(profileId: string, browserSettings?: BrowserSettings, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Stop a running profile by gracefully shutting down its browser engine and releasing allocated resources. Use this endpoint to transition the profile from \'running\' to \'terminated\' state. */ stopProfileRaw(requestParameters: StopProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Stop a running profile by gracefully shutting down its browser engine and releasing allocated resources. Use this endpoint to transition the profile from \'running\' to \'terminated\' state. */ stopProfile(profileId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Update an existing profile’s settings by providing the new configuration options in the request body. Use this to modify aspects like spoofing options or proxy settings, then receive the updated profile details. */ updateProfileRaw(requestParameters: UpdateProfileOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Update an existing profile’s settings by providing the new configuration options in the request body. Use this to modify aspects like spoofing options or proxy settings, then receive the updated profile details. */ updateProfile(profileId: string, updateProfileRequest: UpdateProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Upgrades the profile\'s fingerprint to the most recent browser version available from the server. This also updates the profile\'s corresponding kernel if there\'s a better match available for the new fingerprint. The new fingerprint is tailored to the profile\'s current device, browser and operating system. Note that upgrading a profile\'s kernel will alter its browser fingerprint. */ upgradeProfileKernelRaw(requestParameters: UpgradeProfileKernelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Upgrades the profile\'s fingerprint to the most recent browser version available from the server. This also updates the profile\'s corresponding kernel if there\'s a better match available for the new fingerprint. The new fingerprint is tailored to the profile\'s current device, browser and operating system. Note that upgrading a profile\'s kernel will alter its browser fingerprint. */ upgradeProfileKernel(profileId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; }