api.md

Shared

Types:

• DeviceCarrier
• DeviceIdentifiers
• DeviceSpec
• Meta
• Pagination
• PaginationMeta
• PermissionSet

Tasks

Types:

• PackageCredentials
• Task
• TaskStatus
• UsageResult
• TaskRetrieveResponse
• TaskListResponse
• TaskGetStatusResponse
• TaskGetTrajectoryResponse
• TaskRunResponse
• TaskRunStreamedResponse
• TaskSendMessageResponse
• TaskStopResponse

Methods:

• client.tasks.retrieve(taskID) -> TaskRetrieveResponse
• client.tasks.list({ ...params }) -> TaskListResponse
• client.tasks.attach(taskID) -> void
• client.tasks.getStatus(taskID) -> TaskGetStatusResponse
• client.tasks.getTrajectory(taskID) -> TaskGetTrajectoryResponse
• client.tasks.run({ ...params }) -> TaskRunResponse
• client.tasks.runStreamed({ ...params }) -> unknown
• client.tasks.sendMessage(taskID, { ...params }) -> TaskSendMessageResponse
• client.tasks.stop(taskID) -> TaskStopResponse

Screenshots

Types:

• MediaResponse
• ScreenshotListResponse

Methods:

• client.tasks.screenshots.retrieve(index, { ...params }) -> MediaResponse
• client.tasks.screenshots.list(taskID) -> ScreenshotListResponse

UiStates

Types:

• UiStateListResponse

Methods:

• client.tasks.uiStates.retrieve(index, { ...params }) -> MediaResponse
• client.tasks.uiStates.list(taskID) -> UiStateListResponse

Agents

Types:

• AgentListResponse

Methods:

• client.agents.list() -> AgentListResponse

Proxies

Types:

• ProxyConfig
• ProxyCreateResponse
• ProxyRetrieveResponse
• ProxyUpdateResponse
• ProxyListResponse
• ProxyDeleteResponse

Methods:

• client.proxies.create({ ...params }) -> ProxyCreateResponse
• client.proxies.retrieve(proxyID) -> ProxyRetrieveResponse
• client.proxies.update(proxyID, { ...params }) -> ProxyUpdateResponse
• client.proxies.list({ ...params }) -> ProxyListResponse
• client.proxies.delete(proxyID) -> ProxyDeleteResponse

Carriers

Types:

• Carrier
• CarrierListResponse
• CarrierDeleteResponse

Methods:

• client.carriers.create({ ...params }) -> Carrier
• client.carriers.retrieve(carrierID) -> Carrier
• client.carriers.update(carrierID, { ...params }) -> Carrier
• client.carriers.list({ ...params }) -> CarrierListResponse
• client.carriers.delete(carrierID) -> CarrierDeleteResponse
• client.carriers.lookup({ ...params }) -> Carrier

Profiles

Types:

• Profile
• ProfileListResponse
• ProfileDeleteResponse

Methods:

• client.profiles.create({ ...params }) -> Profile
• client.profiles.retrieve(profileID) -> Profile
• client.profiles.update(profileID, { ...params }) -> Profile
• client.profiles.list({ ...params }) -> ProfileListResponse
• client.profiles.delete(profileID) -> ProfileDeleteResponse

Devices

Types:

• Device
• DeviceListResponse
• DeviceCountResponse

Methods:

• client.devices.create({ ...params }) -> Device
• client.devices.retrieve(deviceID) -> Device
• client.devices.list({ ...params }) -> DeviceListResponse
• client.devices.count() -> DeviceCountResponse
• client.devices.setName(deviceID, { ...params }) -> Device
• client.devices.terminate(deviceID, { ...params }) -> void
• client.devices.waitReady(deviceID) -> Device

Time

Types:

• TimeTimeResponse
• TimeTimezoneResponse

Methods:

• client.devices.time.setTimezone(deviceID, { ...params }) -> void
• client.devices.time.time(deviceID, { ...params }) -> string
• client.devices.time.timezone(deviceID, { ...params }) -> TimeTimezoneResponse

Profile

Methods:

• client.devices.profile.update(deviceID, { ...params }) -> void

Files

Types:

• FileInfo
• FileListResponse
• FileDownloadResponse

Methods:

• client.devices.files.list(deviceID, { ...params }) -> FileListResponse
• client.devices.files.delete(deviceID, { ...params }) -> void
• client.devices.files.download(deviceID, { ...params }) -> string
• client.devices.files.upload(deviceID, { ...params }) -> void

Proxy

Types:

• ProxyStatusResponse

Methods:

• client.devices.proxy.connect(deviceID, { ...params }) -> void
• client.devices.proxy.disconnect(deviceID, { ...params }) -> void
• client.devices.proxy.status(deviceID, { ...params }) -> ProxyStatusResponse

Location

Types:

• LocationGetResponse

Methods:

• client.devices.location.get(deviceID, { ...params }) -> LocationGetResponse
• client.devices.location.set(deviceID, { ...params }) -> void

Actions

Types:

• ActionOverlayVisibleResponse

Methods:

• client.devices.actions.global(deviceID, { ...params }) -> void
• client.devices.actions.overlayVisible(deviceID, { ...params }) -> ActionOverlayVisibleResponse
• client.devices.actions.setOverlayVisible(deviceID, { ...params }) -> void
• client.devices.actions.swipe(deviceID, { ...params }) -> void
• client.devices.actions.tap(deviceID, { ...params }) -> void

State

Types:

• Rect
• StateScreenshotResponse
• StateUiResponse

Methods:

• client.devices.state.screenshot(deviceID, { ...params }) -> string
• client.devices.state.ui(deviceID, { ...params }) -> StateUiResponse

Apps

Types:

• AppListResponse

Methods:

• client.devices.apps.update(packageName, { ...params }) -> void
• client.devices.apps.list(deviceID, { ...params }) -> AppListResponse | null
• client.devices.apps.delete(packageName, { ...params }) -> void
• client.devices.apps.install(deviceID, { ...params }) -> void
• client.devices.apps.start(packageName, { ...params }) -> void

Packages

Types:

• PackageListResponse

Methods:

• client.devices.packages.list(deviceID, { ...params }) -> PackageListResponse | null

Keyboard

Methods:

• client.devices.keyboard.clear(deviceID, { ...params }) -> void
• client.devices.keyboard.key(deviceID, { ...params }) -> void
• client.devices.keyboard.write(deviceID, { ...params }) -> void

Tasks

Types:

• TaskListResponse

Methods:

• client.devices.tasks.list(deviceID, { ...params }) -> TaskListResponse

Esim

Types:

• EsimListResponse
• EsimActivateResponse

Methods:

• client.devices.esim.list(deviceID, { ...params }) -> EsimListResponse | null
• client.devices.esim.activate(deviceID, { ...params }) -> EsimActivateResponse
• client.devices.esim.enable(deviceID, { ...params }) -> void
• client.devices.esim.remove(deviceID, { ...params }) -> void

Apps

Types:

• AppListResponse

Methods:

• client.apps.list({ ...params }) -> AppListResponse

Credentials

Types:

• CredentialListResponse

Methods:

• client.credentials.list({ ...params }) -> CredentialListResponse

Packages

Types:

• PackageCreateResponse
• PackageListResponse

Methods:

• client.credentials.packages.create({ ...params }) -> PackageCreateResponse
• client.credentials.packages.list(packageName) -> PackageListResponse

Credentials

Types:

• Credential
• CredentialCreateResponse
• CredentialRetrieveResponse
• CredentialDeleteResponse

Methods:

• client.credentials.packages.credentials.create(packageName, { ...params }) -> CredentialCreateResponse
• client.credentials.packages.credentials.retrieve(credentialName, { ...params }) -> CredentialRetrieveResponse
• client.credentials.packages.credentials.delete(credentialName, { ...params }) -> CredentialDeleteResponse

Fields

Types:

• FieldCreateResponse
• FieldUpdateResponse
• FieldDeleteResponse

Methods:

• client.credentials.packages.credentials.fields.create(credentialName, { ...params }) -> FieldCreateResponse
• client.credentials.packages.credentials.fields.update(fieldType, { ...params }) -> FieldUpdateResponse
• client.credentials.packages.credentials.fields.delete(fieldType, { ...params }) -> FieldDeleteResponse

Hooks

Types:

• HookRetrieveResponse
• HookUpdateResponse
• HookListResponse
• HookGetSampleDataResponse
• HookPerformResponse
• HookSubscribeResponse
• HookUnsubscribeResponse

Methods:

• client.hooks.retrieve(hookID) -> HookRetrieveResponse
• client.hooks.update(hookID, { ...params }) -> HookUpdateResponse
• client.hooks.list({ ...params }) -> HookListResponse
• client.hooks.getSampleData() -> HookGetSampleDataResponse
• client.hooks.perform({ ...params }) -> HookPerformResponse
• client.hooks.subscribe({ ...params }) -> HookSubscribeResponse
• client.hooks.unsubscribe(hookID) -> HookUnsubscribeResponse

Models

Types:

• ModelListResponse

Methods:

• client.models.list() -> ModelListResponse