320 lines (231 loc) · 23.2 KB

Shared

Types:

Deployments

Types:

Methods:

client.deployments.create({ ...params }) -> DeploymentCreateResponse
client.deployments.retrieve(id) -> DeploymentRetrieveResponse
client.deployments.list({ ...params }) -> DeploymentListResponsesOffsetPagination
client.deployments.delete(id) -> void
client.deployments.follow(id, { ...params }) -> DeploymentFollowResponse

Apps

Types:

AppListResponse

Methods:

client.apps.list({ ...params }) -> AppListResponsesOffsetPagination

Invocations

Types:

Methods:

client.invocations.create({ ...params }) -> InvocationCreateResponse
client.invocations.retrieve(id) -> InvocationRetrieveResponse
client.invocations.update(id, { ...params }) -> InvocationUpdateResponse
client.invocations.list({ ...params }) -> InvocationListResponsesOffsetPagination
client.invocations.deleteBrowsers(id) -> void
client.invocations.follow(id, { ...params }) -> InvocationFollowResponse
client.invocations.listBrowsers(id) -> InvocationListBrowsersResponse

Browsers

Types:

Methods:

client.browsers.create({ ...params }) -> BrowserCreateResponse
client.browsers.retrieve(id, { ...params }) -> BrowserRetrieveResponse
client.browsers.update(id, { ...params }) -> BrowserUpdateResponse
client.browsers.list({ ...params }) -> BrowserListResponsesOffsetPagination
client.browsers.delete({ ...params }) -> void
client.browsers.deleteByID(id) -> void
client.browsers.loadExtensions(id, { ...params }) -> void

Replays

Types:

Methods:

client.browsers.replays.list(id) -> ReplayListResponse
client.browsers.replays.download(replayID, { ...params }) -> Response
client.browsers.replays.start(id, { ...params }) -> ReplayStartResponse
client.browsers.replays.stop(replayID, { ...params }) -> void

Fs

Types:

Methods:

client.browsers.fs.createDirectory(id, { ...params }) -> void
client.browsers.fs.deleteDirectory(id, { ...params }) -> void
client.browsers.fs.deleteFile(id, { ...params }) -> void
client.browsers.fs.downloadDirZip(id, { ...params }) -> Response
client.browsers.fs.fileInfo(id, { ...params }) -> FFileInfoResponse
client.browsers.fs.listFiles(id, { ...params }) -> FListFilesResponse
client.browsers.fs.move(id, { ...params }) -> void
client.browsers.fs.readFile(id, { ...params }) -> Response
client.browsers.fs.setFilePermissions(id, { ...params }) -> void
client.browsers.fs.upload(id, { ...params }) -> void
client.browsers.fs.uploadZip(id, { ...params }) -> void
client.browsers.fs.writeFile(id, contents, { ...params }) -> void

Watch

Types:

Methods:

client.browsers.fs.watch.events(watchID, { ...params }) -> WatchEventsResponse
client.browsers.fs.watch.start(id, { ...params }) -> WatchStartResponse
client.browsers.fs.watch.stop(watchID, { ...params }) -> void

Process

Types:

Methods:

client.browsers.process.exec(id, { ...params }) -> ProcessExecResponse
client.browsers.process.kill(processID, { ...params }) -> ProcessKillResponse
client.browsers.process.resize(processID, { ...params }) -> ProcessResizeResponse
client.browsers.process.spawn(id, { ...params }) -> ProcessSpawnResponse
client.browsers.process.status(processID, { ...params }) -> ProcessStatusResponse
client.browsers.process.stdin(processID, { ...params }) -> ProcessStdinResponse
client.browsers.process.stdoutStream(processID, { ...params }) -> ProcessStdoutStreamResponse

Logs

Methods:

client.browsers.logs.stream(id, { ...params }) -> LogEvent

Computer

Types:

Methods:

client.browsers.computer.batch(id, { ...params }) -> void
client.browsers.computer.captureScreenshot(id, { ...params }) -> Response
client.browsers.computer.clickMouse(id, { ...params }) -> void
client.browsers.computer.dragMouse(id, { ...params }) -> void
client.browsers.computer.getMousePosition(id) -> ComputerGetMousePositionResponse
client.browsers.computer.moveMouse(id, { ...params }) -> void
client.browsers.computer.pressKey(id, { ...params }) -> void
client.browsers.computer.readClipboard(id) -> ComputerReadClipboardResponse
client.browsers.computer.scroll(id, { ...params }) -> void
client.browsers.computer.setCursorVisibility(id, { ...params }) -> ComputerSetCursorVisibilityResponse
client.browsers.computer.typeText(id, { ...params }) -> void
client.browsers.computer.writeClipboard(id, { ...params }) -> void

Playwright

Types:

PlaywrightExecuteResponse

Methods:

client.browsers.playwright.execute(id, { ...params }) -> PlaywrightExecuteResponse

Profiles

Methods:

client.profiles.create({ ...params }) -> Profile
client.profiles.retrieve(idOrName) -> Profile
client.profiles.list({ ...params }) -> ProfilesOffsetPagination
client.profiles.delete(idOrName) -> void
client.profiles.download(idOrName) -> Response

Auth

Connections

Types:

Methods:

client.auth.connections.create({ ...params }) -> ManagedAuth
client.auth.connections.retrieve(id) -> ManagedAuth
client.auth.connections.list({ ...params }) -> ManagedAuthsOffsetPagination
client.auth.connections.delete(id) -> void
client.auth.connections.follow(id) -> ConnectionFollowResponse
client.auth.connections.login(id, { ...params }) -> LoginResponse
client.auth.connections.submit(id, { ...params }) -> SubmitFieldsResponse

Proxies

Types:

Methods:

client.proxies.create({ ...params }) -> ProxyCreateResponse
client.proxies.retrieve(id) -> ProxyRetrieveResponse
client.proxies.list() -> ProxyListResponse
client.proxies.delete(id) -> void
client.proxies.check(id) -> ProxyCheckResponse

Extensions

Types:

Methods:

client.extensions.list() -> ExtensionListResponse
client.extensions.delete(idOrName) -> void
client.extensions.download(idOrName) -> Response
client.extensions.downloadFromChromeStore({ ...params }) -> Response
client.extensions.upload({ ...params }) -> ExtensionUploadResponse

BrowserPools

Types:

Methods:

client.browserPools.create({ ...params }) -> BrowserPool
client.browserPools.retrieve(idOrName) -> BrowserPool
client.browserPools.update(idOrName, { ...params }) -> BrowserPool
client.browserPools.list() -> BrowserPoolListResponse
client.browserPools.delete(idOrName, { ...params }) -> void
client.browserPools.acquire(idOrName, { ...params }) -> BrowserPoolAcquireResponse
client.browserPools.flush(idOrName) -> void
client.browserPools.release(idOrName, { ...params }) -> void

Credentials

Types:

Methods:

client.credentials.create({ ...params }) -> Credential
client.credentials.retrieve(idOrName) -> Credential
client.credentials.update(idOrName, { ...params }) -> Credential
client.credentials.list({ ...params }) -> CredentialsOffsetPagination
client.credentials.delete(idOrName) -> void
client.credentials.totpCode(idOrName) -> CredentialTotpCodeResponse

CredentialProviders

Types:

Methods:

client.credentialProviders.create({ ...params }) -> CredentialProvider
client.credentialProviders.retrieve(id) -> CredentialProvider
client.credentialProviders.update(id, { ...params }) -> CredentialProvider
client.credentialProviders.list() -> CredentialProviderListResponse
client.credentialProviders.delete(id) -> void
client.credentialProviders.listItems(id) -> CredentialProviderListItemsResponse
client.credentialProviders.test(id) -> CredentialProviderTestResult