api.md

Shared Types

from mobilerun.types import (
    Config,
    DeviceCarrier,
    DeviceIdentifiers,
    DeviceSpec,
    Meta,
    Pagination,
    PaginationMeta,
    PermissionSet,
)

Tasks

Types:

from mobilerun.types import (
    PackageCredentials,
    Task,
    TaskStatus,
    UsageResult,
    TaskRetrieveResponse,
    TaskListResponse,
    TaskGetStatusResponse,
    TaskGetTrajectoryResponse,
    TaskRunResponse,
    TaskSendMessageResponse,
    TaskStopResponse,
)

Methods:

• client.tasks.retrieve(task_id) -> TaskRetrieveResponse
• client.tasks.list(**params) -> TaskListResponse
• client.tasks.attach(task_id) -> None
• client.tasks.get_status(task_id) -> TaskGetStatusResponse
• client.tasks.get_trajectory(task_id) -> TaskGetTrajectoryResponse
• client.tasks.run(**params) -> TaskRunResponse
• client.tasks.run_streamed(**params) -> object
• client.tasks.send_message(task_id, **params) -> TaskSendMessageResponse
• client.tasks.stop(task_id) -> TaskStopResponse

Screenshots

Types:

from mobilerun.types.tasks import MediaResponse, ScreenshotListResponse

Methods:

• client.tasks.screenshots.retrieve(index, *, task_id) -> MediaResponse
• client.tasks.screenshots.list(task_id) -> ScreenshotListResponse

UiStates

Types:

from mobilerun.types.tasks import UiStateListResponse

Methods:

• client.tasks.ui_states.retrieve(index, *, task_id) -> MediaResponse
• client.tasks.ui_states.list(task_id) -> UiStateListResponse

Agents

Types:

from mobilerun.types import AgentListResponse

Methods:

• client.agents.list() -> AgentListResponse

Proxies

Types:

from mobilerun.types import (
    ProxyConfig,
    ProxyCreateResponse,
    ProxyRetrieveResponse,
    ProxyUpdateResponse,
    ProxyListResponse,
    ProxyDeleteResponse,
)

Methods:

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

Carriers

Types:

from mobilerun.types import Carrier, CarrierListResponse, CarrierDeleteResponse

Methods:

• client.carriers.create(**params) -> Carrier
• client.carriers.retrieve(carrier_id) -> Carrier
• client.carriers.update(carrier_id, **params) -> Carrier
• client.carriers.list(**params) -> CarrierListResponse
• client.carriers.delete(carrier_id) -> CarrierDeleteResponse
• client.carriers.lookup(**params) -> Carrier

Profiles

Types:

from mobilerun.types import Profile, ProfileListResponse, ProfileDeleteResponse

Methods:

• client.profiles.create(**params) -> Profile
• client.profiles.retrieve(profile_id) -> Profile
• client.profiles.update(profile_id, **params) -> Profile
• client.profiles.list(**params) -> ProfileListResponse
• client.profiles.delete(profile_id) -> ProfileDeleteResponse

Devices

Types:

from mobilerun.types import Device, DeviceListResponse, DeviceCountResponse

Methods:

• client.devices.create(**params) -> Device
• client.devices.retrieve(device_id) -> Device
• client.devices.list(**params) -> DeviceListResponse
• client.devices.count() -> DeviceCountResponse
• client.devices.terminate(device_id, **params) -> None
• client.devices.wait_ready(device_id) -> Device

Time

Types:

from mobilerun.types.devices import TimeTimeResponse, TimeTimezoneResponse

Methods:

• client.devices.time.set_time(device_id, **params) -> None
• client.devices.time.set_timezone(device_id, **params) -> None
• client.devices.time.time(device_id) -> str
• client.devices.time.timezone(device_id) -> TimeTimezoneResponse

Profile

Methods:

• client.devices.profile.update(device_id, **params) -> None

Files

Types:

from mobilerun.types.devices import FileInfo, FileListResponse, FileDownloadResponse

Methods:

• client.devices.files.list(device_id, **params) -> FileListResponse
• client.devices.files.delete(device_id, **params) -> None
• client.devices.files.download(device_id, **params) -> str
• client.devices.files.upload(device_id, **params) -> None

Proxy

Methods:

• client.devices.proxy.connect(device_id, **params) -> None
• client.devices.proxy.disconnect(device_id) -> None

Location

Types:

from mobilerun.types.devices import LocationGetResponse

Methods:

• client.devices.location.get(device_id) -> LocationGetResponse
• client.devices.location.set(device_id, **params) -> None

Actions

Types:

from mobilerun.types.devices import ActionOverlayVisibleResponse

Methods:

• client.devices.actions.global_(device_id, **params) -> None
• client.devices.actions.overlay_visible(device_id) -> ActionOverlayVisibleResponse
• client.devices.actions.set_overlay_visible(device_id, **params) -> None
• client.devices.actions.swipe(device_id, **params) -> None
• client.devices.actions.tap(device_id, **params) -> None

State

Types:

from mobilerun.types.devices import Rect, StateScreenshotResponse, StateUiResponse

Methods:

• client.devices.state.screenshot(device_id, **params) -> str
• client.devices.state.ui(device_id, **params) -> StateUiResponse

Apps

Types:

from mobilerun.types.devices import AppListResponse

Methods:

• client.devices.apps.update(package_name, *, device_id) -> None
• client.devices.apps.list(device_id, **params) -> Optional[AppListResponse]
• client.devices.apps.delete(package_name, *, device_id) -> None
• client.devices.apps.install(device_id, **params) -> None
• client.devices.apps.start(package_name, *, device_id, **params) -> None

Packages

Types:

from mobilerun.types.devices import PackageListResponse

Methods:

• client.devices.packages.list(device_id, **params) -> Optional[PackageListResponse]

Keyboard

Methods:

• client.devices.keyboard.clear(device_id) -> None
• client.devices.keyboard.key(device_id, **params) -> None
• client.devices.keyboard.write(device_id, **params) -> None

Tasks

Types:

from mobilerun.types.devices import TaskListResponse

Methods:

• client.devices.tasks.list(device_id, **params) -> TaskListResponse

Apps

Types:

from mobilerun.types import AppListResponse

Methods:

• client.apps.list(**params) -> AppListResponse

Credentials

Types:

from mobilerun.types import CredentialListResponse

Methods:

• client.credentials.list(**params) -> CredentialListResponse

Packages

Types:

from mobilerun.types.credentials import PackageCreateResponse, PackageListResponse

Methods:

• client.credentials.packages.create(**params) -> PackageCreateResponse
• client.credentials.packages.list(package_name) -> PackageListResponse

Credentials

Types:

from mobilerun.types.credentials.packages import (
    Credential,
    CredentialCreateResponse,
    CredentialRetrieveResponse,
    CredentialDeleteResponse,
)

Methods:

• client.credentials.packages.credentials.create(package_name, **params) -> CredentialCreateResponse
• client.credentials.packages.credentials.retrieve(credential_name, *, package_name) -> CredentialRetrieveResponse
• client.credentials.packages.credentials.delete(credential_name, *, package_name) -> CredentialDeleteResponse

Fields

Types:

from mobilerun.types.credentials.packages.credentials import (
    FieldCreateResponse,
    FieldUpdateResponse,
    FieldDeleteResponse,
)

Methods:

• client.credentials.packages.credentials.fields.create(credential_name, *, package_name, **params) -> FieldCreateResponse
• client.credentials.packages.credentials.fields.update(field_type, *, package_name, credential_name, **params) -> FieldUpdateResponse
• client.credentials.packages.credentials.fields.delete(field_type, *, package_name, credential_name) -> FieldDeleteResponse

Hooks

Types:

from mobilerun.types import (
    HookRetrieveResponse,
    HookUpdateResponse,
    HookListResponse,
    HookGetSampleDataResponse,
    HookPerformResponse,
    HookSubscribeResponse,
    HookUnsubscribeResponse,
)

Methods:

• client.hooks.retrieve(hook_id) -> HookRetrieveResponse
• client.hooks.update(hook_id, **params) -> HookUpdateResponse
• client.hooks.list(**params) -> HookListResponse
• client.hooks.get_sample_data() -> HookGetSampleDataResponse
• client.hooks.perform(**params) -> HookPerformResponse
• client.hooks.subscribe(**params) -> HookSubscribeResponse
• client.hooks.unsubscribe(hook_id) -> HookUnsubscribeResponse

Models

Types:

from mobilerun.types import ModelListResponse

Methods:

• client.models.list() -> ModelListResponse