/** * 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 type { FontSpoofingType } from "./FontSpoofingType"; import type { ProfileStorageLocation } from "./ProfileStorageLocation"; import type { ScreenChoice } from "./ScreenChoice"; import type { AudioSpoofingType } from "./AudioSpoofingType"; import type { PasswordManagerType } from "./PasswordManagerType"; import type { WebglSpoofingType } from "./WebglSpoofingType"; import type { CanvasSpoofingType } from "./CanvasSpoofingType"; import type { DeviceMemoryChoice } from "./DeviceMemoryChoice"; import type { WebglMetaChoice } from "./WebglMetaChoice"; import type { GeolocationChoice } from "./GeolocationChoice"; import type { HardwareConcurrencyChoice } from "./HardwareConcurrencyChoice"; import type { ProxyChoice } from "./ProxyChoice"; import type { WebRtcChoice } from "./WebRtcChoice"; import type { TimezoneChoice } from "./TimezoneChoice"; /** * * @export * @interface CreateProfileRequest */ export interface CreateProfileRequest { /** * The unique identifier of the fingerprint. This references the fingerprint which should be used to build the new profile. * @type {string} * @memberof CreateProfileRequest */ fingerprintId: string; /** * Sets a human-readable name for the profile, which is modifiable at any time. * @type {string} * @memberof CreateProfileRequest */ name?: string | null; /** * Id of the folder the profile should be created in. If null or empty (00000000-0000-0000-0000-000000000000) the profile will be created in root. * @type {string} * @memberof CreateProfileRequest */ folderId?: string | null; /** * Use tags to categorize profiles by labeling them accordingly. * @type {Array} * @memberof CreateProfileRequest */ tags?: Array | null; /** * Specifies how the canvas will be spoofed. Possible values: * 'intelligent': Use intelligent canvas spoofing. This will result non-unique canvas fingerprints. * 'noise': Add some noise to canvas generation. * 'block': Completely block the 2D API. * 'off': Turn off the spoofing, use the original settings. * @type {CanvasSpoofingType} * @memberof CreateProfileRequest */ canvas?: CanvasSpoofingType; /** * Specifies how the WebGL will be spoofed. Possible values: * 'noise': Add some noise to the WebGL generation * 'block': Completely block the 3D API * 'off': Turn off the spoofing, use the original settings * @type {WebglSpoofingType} * @memberof CreateProfileRequest */ webgl?: WebglSpoofingType; /** * Sets how the WebGL Vendor and Renderer will be spoofed. Values can be 'automatic', 'manual', 'off'. * @type {WebglMetaChoice} * @memberof CreateProfileRequest */ webglMeta?: WebglMetaChoice | null; /** * Specifies how the audio will be spoofed. Possible values: * 'noise': Add some noise to the Audio generation * 'block': Completely block the Audio API * 'off': Turn off the spoofing, use the original settings * @type {AudioSpoofingType} * @memberof CreateProfileRequest */ audio?: AudioSpoofingType; /** * Sets how the Timezone will be spoofed. Values can be 'automatic', 'manual', 'off'. * @type {TimezoneChoice} * @memberof CreateProfileRequest */ timezone?: TimezoneChoice | null; /** * Sets how the Geolocation will be spoofed. Values can be 'automatic', 'manual', 'block', 'off'. * @type {GeolocationChoice} * @memberof CreateProfileRequest */ geolocation?: GeolocationChoice | null; /** * Sets the Proxy connection settings of the profile. Values can be 'none', 'http', 'socks5', 'ssh'. When it is not set to none, a server must * be provided. * @type {ProxyChoice} * @memberof CreateProfileRequest */ proxy?: ProxyChoice | null; /** * Sets how the WebRTC will be spoofed. Values can be 'automatic', 'manual', 'block', 'off'. * @type {WebRtcChoice} * @memberof CreateProfileRequest */ webRtc?: WebRtcChoice | null; /** * Specifies how the fonts will be spoofed. Possible values: * 'automatic': Spoof fonts based on the browser fingerpint. * 'off': Don't spoof fonts, use the real fonts of your machine. * @type {FontSpoofingType} * @memberof CreateProfileRequest */ fonts?: FontSpoofingType; /** * Sets how the Screen will be spoofed. Values can be 'automatic', 'manual', 'off'. When value is set to manual, a ScreenSize must be * provided. * @type {ScreenChoice} * @memberof CreateProfileRequest */ screen?: ScreenChoice | null; /** * Sets how the Hardware Concurrency will be spoofed. Values can be 'automatic', 'manual', 'off'. When value is set to manual, a numeric value * (1, 2, 4, 8, 12 or 16) must be provided. * @type {HardwareConcurrencyChoice} * @memberof CreateProfileRequest */ hardwareConcurrency?: HardwareConcurrencyChoice | null; /** * Sets how the Device Memory will be spoofed. Values can be 'automatic', 'manual', 'off'. When value is set to manual, a numeric value (0.25, * 0.5, 1, 2, 4, 8, 16, 32) must be provided. * @type {DeviceMemoryChoice} * @memberof CreateProfileRequest */ deviceMemory?: DeviceMemoryChoice | null; /** * A language or a comma-separated list of languages for the profile. * ISO 639-1 language and optionally ISO 3166-1 region code. * @type {string} * @memberof CreateProfileRequest */ language?: string | null; /** * This website will be opened in the browser when the profile launches. * @type {string} * @memberof CreateProfileRequest */ startPage?: string | null; /** * Defines whether the browser can save login credentials. Possible values are: * 'enabled': Credential saving is allowed. * 'disabled': Credential saving is blocked. * @type {PasswordManagerType} * @memberof CreateProfileRequest */ passwordManager?: PasswordManagerType; /** * A list of abolute paths from where the profile should load extensions or addons when starting the browser. For chrome and edge use CRX3 * format extensions. For firefox use signed xpi format addons. * @type {Array} * @memberof CreateProfileRequest */ extensions?: Array | null; /** * A free text including any notes written by the user. * @type {string} * @memberof CreateProfileRequest */ notes?: string | null; /** * Profile storage property which determines where the profile is stored. The default value is 'local'. When the value is changed the profile * will be migrated. * @type {ProfileStorageLocation} * @memberof CreateProfileRequest */ storage?: ProfileStorageLocation; } /** * Check if a given object implements the CreateProfileRequest interface. */ export declare function instanceOfCreateProfileRequest(value: object): value is CreateProfileRequest; export declare function CreateProfileRequestFromJSON(json: any): CreateProfileRequest; export declare function CreateProfileRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateProfileRequest; export declare function CreateProfileRequestToJSON(json: any): CreateProfileRequest; export declare function CreateProfileRequestToJSONTyped(value?: CreateProfileRequest | null, ignoreDiscriminator?: boolean): any;