api.md

Shared Types

from mobilerun_sdk.types import (
    DeviceCarrier,
    DeviceIdentifiers,
    DeviceSpec,
    Location,
    Meta,
    Pagination,
    PaginationMeta,
    PermissionSet,
    Socks5ProxyConfig,
)

Apps

Types:

from mobilerun_sdk.types import (
    AppRetrieveResponse,
    AppListResponse,
    AppDeleteResponse,
    AppConfirmUploadResponse,
    AppCreateSignedUploadURLResponse,
    AppListVersionsResponse,
    AppMarkFailedResponse,
    AppStorageUsageResponse,
)

Methods:

• client.apps.retrieve(id) -> AppRetrieveResponse
• client.apps.list(**params) -> AppListResponse
• client.apps.delete(id) -> AppDeleteResponse
• client.apps.confirm_upload(id) -> AppConfirmUploadResponse
• client.apps.create_signed_upload_url(**params) -> AppCreateSignedUploadURLResponse
• client.apps.list_versions(id) -> AppListVersionsResponse
• client.apps.mark_failed(id) -> AppMarkFailedResponse
• client.apps.storage_usage() -> AppStorageUsageResponse

Carriers

Types:

from mobilerun_sdk.types import (
    CarrierCreateResponse,
    CarrierRetrieveResponse,
    CarrierUpdateResponse,
    CarrierListResponse,
    CarrierDeleteResponse,
    CarrierLookupResponse,
)

Methods:

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

Credentials

Types:

from mobilerun_sdk.types import CredentialListResponse

Methods:

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

Packages

Types:

from mobilerun_sdk.types.credentials import (
    PackageCreateResponse,
    PackageListResponse,
    PackageListAllResponse,
)

Methods:

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

Credentials

Types:

from mobilerun_sdk.types.credentials.packages import (
    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_sdk.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

Devices

Types:

from mobilerun_sdk.types import (
    DeviceCreateResponse,
    DeviceRetrieveResponse,
    DeviceListResponse,
    DeviceCountResponse,
    DeviceFingerprintResponse,
    DeviceRetrieveCapabilitiesResponse,
    DeviceSetNameResponse,
    DeviceWaitReadyResponse,
)

Methods:

• client.devices.create(**params) -> DeviceCreateResponse
• client.devices.retrieve(device_id) -> DeviceRetrieveResponse
• client.devices.list(**params) -> DeviceListResponse
• client.devices.count() -> DeviceCountResponse
• client.devices.fingerprint(device_id) -> DeviceFingerprintResponse
• client.devices.reboot(device_id) -> None
• client.devices.reset(device_id) -> None
• client.devices.resume(device_id) -> None
• client.devices.retrieve_capabilities(device_id) -> DeviceRetrieveCapabilitiesResponse
• client.devices.set_name(device_id, **params) -> DeviceSetNameResponse
• client.devices.stop(device_id) -> None
• client.devices.terminate(device_id, **params) -> None
• client.devices.wait_ready(device_id) -> DeviceWaitReadyResponse

Actions

Types:

from mobilerun_sdk.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

Apps

Types:

from mobilerun_sdk.types.devices import AppListResponse, AppListInstallsResponse

Methods:

• client.devices.apps.list(device_id, **params) -> Optional[AppListResponse]
• client.devices.apps.delete(package_name, *, device_id) -> None
• client.devices.apps.grant_permission(permission, *, device_id, package_name) -> None
• client.devices.apps.install(device_id, **params) -> None
• client.devices.apps.list_installs(device_id) -> AppListInstallsResponse
• client.devices.apps.revoke_permission(permission, *, device_id, package_name) -> None
• client.devices.apps.start(package_name, *, device_id, **params) -> None
• client.devices.apps.stop(package_name, *, device_id, **params) -> None

Esim

Types:

from mobilerun_sdk.types.devices import EsimListResponse, EsimActivateResponse, EsimStatusResponse

Methods:

• client.devices.esim.list(device_id) -> Optional[EsimListResponse]
• client.devices.esim.activate(device_id, **params) -> EsimActivateResponse
• client.devices.esim.enable(device_id, **params) -> None
• client.devices.esim.remove(device_id, **params) -> None
• client.devices.esim.set_roaming(device_id, **params) -> None
• client.devices.esim.status(device_id) -> Optional[EsimStatusResponse]

Apn

Types:

from mobilerun_sdk.types.devices.esim import ApnListResponse

Methods:

• client.devices.esim.apn.list(device_id) -> Optional[ApnListResponse]
• client.devices.esim.apn.select(device_id, **params) -> None
• client.devices.esim.apn.set(device_id, **params) -> None

Files

Types:

from mobilerun_sdk.types.devices import 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

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

Location

Methods:

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

Packages

Types:

from mobilerun_sdk.types.devices import PackageListResponse

Methods:

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

Profile

Methods:

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

Proxy

Types:

from mobilerun_sdk.types.devices import ProxyStatusResponse

Methods:

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

State

Types:

from mobilerun_sdk.types.devices import (
    A11YNode,
    StateScreenshotResponse,
    StateTimeResponse,
    StateUiResponse,
)

Methods:

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

Tasks

Types:

from mobilerun_sdk.types.devices import TaskListResponse

Methods:

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

Timezone

Types:

from mobilerun_sdk.types.devices import TimezoneGetResponse

Methods:

• client.devices.timezone.get(device_id) -> TimezoneGetResponse
• client.devices.timezone.set(device_id, **params) -> None

Language

Types:

from mobilerun_sdk.types.devices import LanguageGetResponse

Methods:

• client.devices.language.get(device_id) -> LanguageGetResponse
• client.devices.language.set(device_id, **params) -> None

DeepLink

Methods:

• client.devices.deep_link.execute_deep_link(device_id, **params) -> None

Browser

Types:

from mobilerun_sdk.types.devices import BrowserExecuteScriptResponse

Methods:

• client.devices.browser.execute_script(device_id, **params) -> BrowserExecuteScriptResponse

Kiosk

Methods:

• client.devices.kiosk.disable(device_id) -> None
• client.devices.kiosk.enable(device_id, **params) -> None

MediaSessions

Types:

from mobilerun_sdk.types.devices import (
    MediaSessionCreateResponse,
    MediaSessionActivateResponse,
    MediaSessionRetrieveCurrentResponse,
)

Methods:

• client.devices.media_sessions.create(device_id, **params) -> MediaSessionCreateResponse
• client.devices.media_sessions.delete(session_id, *, device_id) -> None
• client.devices.media_sessions.activate(session_id, *, device_id) -> MediaSessionActivateResponse
• client.devices.media_sessions.retrieve_current(device_id) -> MediaSessionRetrieveCurrentResponse

Recordings

Types:

from mobilerun_sdk.types.devices import (
    RecordingListResponse,
    RecordingStartResponse,
    RecordingStatusResponse,
    RecordingStopResponse,
)

Methods:

• client.devices.recordings.list(device_id, **params) -> Optional[RecordingListResponse]
• client.devices.recordings.delete(recording_id, *, device_id) -> None
• client.devices.recordings.start(device_id, **params) -> RecordingStartResponse
• client.devices.recordings.status(recording_id, *, device_id) -> RecordingStatusResponse
• client.devices.recordings.stop(recording_id, *, device_id) -> RecordingStopResponse
• client.devices.recordings.trajectory(recording_id, *, device_id) -> None
• client.devices.recordings.video(recording_id, *, device_id) -> None

Models

Types:

from mobilerun_sdk.types import ModelListResponse

Methods:

• client.models.list() -> ModelListResponse

Profiles

Types:

from mobilerun_sdk.types import (
    ProfileCreateResponse,
    ProfileRetrieveResponse,
    ProfileUpdateResponse,
    ProfileListResponse,
    ProfileDeleteResponse,
)

Methods:

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

Proxies

Types:

from mobilerun_sdk.types import (
    ProxyCreateResponse,
    ProxyRetrieveResponse,
    ProxyUpdateResponse,
    ProxyListResponse,
    ProxyDeleteResponse,
    ProxyLookupResponse,
)

Methods:

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

Connect

Countries

Types:

from mobilerun_sdk.types.connect import CountryListResponse

Methods:

• client.connect.countries.list(**params) -> CountryListResponse

Proxies

Types:

from mobilerun_sdk.types.connect import (
    ProxyRetrieveResponse,
    ProxyListResponse,
    ProxyBuyResponse,
    ProxyListConnectionsResponse,
    ProxyPingResponse,
)

Methods:

• client.connect.proxies.retrieve(id) -> ProxyRetrieveResponse
• client.connect.proxies.list(**params) -> ProxyListResponse
• client.connect.proxies.buy(**params) -> ProxyBuyResponse
• client.connect.proxies.cancel(id) -> None
• client.connect.proxies.list_connections(id, **params) -> ProxyListConnectionsResponse
• client.connect.proxies.ping(id) -> ProxyPingResponse

Users

Types:

from mobilerun_sdk.types.connect import (
    UserCreateResponse,
    UserRetrieveResponse,
    UserUpdateResponse,
    UserListResponse,
    UserListConnectionsResponse,
)

Methods:

• client.connect.users.create(**params) -> UserCreateResponse
• client.connect.users.retrieve(id) -> UserRetrieveResponse
• client.connect.users.update(id, **params) -> UserUpdateResponse
• client.connect.users.list(**params) -> UserListResponse
• client.connect.users.delete(id) -> None
• client.connect.users.list_connections(id, **params) -> UserListConnectionsResponse

Tasks

Types:

from mobilerun_sdk.types import (
    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_sdk.types.tasks import ScreenshotRetrieveResponse, ScreenshotListResponse

Methods:

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

UiStates

Types:

from mobilerun_sdk.types.tasks import UiStateRetrieveResponse, UiStateListResponse

Methods:

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

Workflows

Triggers

Types:

from mobilerun_sdk.types.workflows import (
    TriggerCreateResponse,
    TriggerRetrieveResponse,
    TriggerUpdateResponse,
    TriggerListResponse,
    TriggerDeleteResponse,
    TriggerFireResponse,
)

Methods:

• client.workflows.triggers.create(**params) -> TriggerCreateResponse
• client.workflows.triggers.retrieve(trigger_id) -> TriggerRetrieveResponse
• client.workflows.triggers.update(trigger_id, **params) -> TriggerUpdateResponse
• client.workflows.triggers.list(**params) -> TriggerListResponse
• client.workflows.triggers.delete(trigger_id) -> TriggerDeleteResponse
• client.workflows.triggers.fire(trigger_id, **params) -> TriggerFireResponse

ActionCatalog

Types:

from mobilerun_sdk.types.workflows import ActionCatalogRetrieveResponse, ActionCatalogListResponse

Methods:

• client.workflows.action_catalog.retrieve(catalog_entry_id) -> ActionCatalogRetrieveResponse
• client.workflows.action_catalog.list(**params) -> ActionCatalogListResponse

Actions

Types:

from mobilerun_sdk.types.workflows import (
    ActionCreateResponse,
    ActionRetrieveResponse,
    ActionUpdateResponse,
    ActionListResponse,
    ActionDeleteResponse,
)

Methods:

• client.workflows.actions.create(**params) -> ActionCreateResponse
• client.workflows.actions.retrieve(action_id) -> ActionRetrieveResponse
• client.workflows.actions.update(action_id, **params) -> ActionUpdateResponse
• client.workflows.actions.list(**params) -> ActionListResponse
• client.workflows.actions.delete(action_id) -> ActionDeleteResponse

Services

Types:

from mobilerun_sdk.types.workflows.actions import ServiceListResponse, ServiceListMethodsResponse

Methods:

• client.workflows.actions.services.list() -> ServiceListResponse
• client.workflows.actions.services.list_methods(service) -> ServiceListMethodsResponse

Flows

Types:

from mobilerun_sdk.types.workflows import (
    FlowCreateResponse,
    FlowRetrieveResponse,
    FlowUpdateResponse,
    FlowListResponse,
    FlowDeleteResponse,
    FlowCloneResponse,
    FlowDryRunResponse,
    FlowListRepairsResponse,
    FlowUnblockResponse,
)

Methods:

• client.workflows.flows.create(**params) -> FlowCreateResponse
• client.workflows.flows.retrieve(flow_id) -> FlowRetrieveResponse
• client.workflows.flows.update(flow_id, **params) -> FlowUpdateResponse
• client.workflows.flows.list(**params) -> FlowListResponse
• client.workflows.flows.delete(flow_id) -> FlowDeleteResponse
• client.workflows.flows.clone(flow_id, **params) -> FlowCloneResponse
• client.workflows.flows.dry_run(flow_id, **params) -> FlowDryRunResponse
• client.workflows.flows.list_repairs(flow_id) -> FlowListRepairsResponse
• client.workflows.flows.unblock(flow_id) -> FlowUnblockResponse

Actions

Types:

from mobilerun_sdk.types.workflows.flows import (
    ActionListResponse,
    ActionAddResponse,
    ActionRemoveResponse,
    ActionReplaceResponse,
)

Methods:

• client.workflows.flows.actions.list(flow_id) -> ActionListResponse
• client.workflows.flows.actions.add(flow_id, **params) -> ActionAddResponse
• client.workflows.flows.actions.remove(flow_action_id, *, flow_id) -> ActionRemoveResponse
• client.workflows.flows.actions.replace(flow_id, **params) -> ActionReplaceResponse

Events

Types:

from mobilerun_sdk.types.workflows import EventDryRunResponse, EventIngestResponse

Methods:

• client.workflows.events.dry_run(**params) -> EventDryRunResponse
• client.workflows.events.ingest(**params) -> EventIngestResponse

Executions

Types:

from mobilerun_sdk.types.workflows import (
    ExecutionRetrieveResponse,
    ExecutionListResponse,
    ExecutionAbortResponse,
    ExecutionGetMetricsResponse,
)

Methods:

• client.workflows.executions.retrieve(execution_id) -> ExecutionRetrieveResponse
• client.workflows.executions.list(**params) -> ExecutionListResponse
• client.workflows.executions.abort(execution_id) -> ExecutionAbortResponse
• client.workflows.executions.get_metrics(**params) -> ExecutionGetMetricsResponse

Timezones

Types:

from mobilerun_sdk.types.workflows import TimezoneListResponse

Methods:

• client.workflows.timezones.list() -> TimezoneListResponse

Webhooks

Types:

from mobilerun_sdk.types import (
    WebhookCreateResponse,
    WebhookRetrieveResponse,
    WebhookUpdateResponse,
    WebhookListResponse,
    WebhookEventTypesResponse,
    WebhookRotateSecretResponse,
    WebhookTestDeliveryResponse,
)

Methods:

• client.webhooks.create(**params) -> WebhookCreateResponse
• client.webhooks.retrieve(id) -> WebhookRetrieveResponse
• client.webhooks.update(id, **params) -> WebhookUpdateResponse
• client.webhooks.list(**params) -> WebhookListResponse
• client.webhooks.delete(id) -> None
• client.webhooks.event_types() -> WebhookEventTypesResponse
• client.webhooks.rotate_secret(id) -> WebhookRotateSecretResponse
• client.webhooks.test_delivery(id) -> WebhookTestDeliveryResponse

Deliveries

Types:

from mobilerun_sdk.types.webhooks import (
    DeliveryListResponse,
    DeliveryListForWebhookResponse,
    DeliveryRetrieveAttemptsResponse,
    DeliveryStatsResponse,
)

Methods:

• client.webhooks.deliveries.list(**params) -> DeliveryListResponse
• client.webhooks.deliveries.list_for_webhook(id, **params) -> DeliveryListForWebhookResponse
• client.webhooks.deliveries.retrieve_attempts(delivery_id, *, id) -> DeliveryRetrieveAttemptsResponse
• client.webhooks.deliveries.stats(**params) -> DeliveryStatsResponse

Agents

Types:

from mobilerun_sdk.types import AgentListResponse

Methods:

• client.agents.list() -> AgentListResponse

AppEvents

Types:

from mobilerun_sdk.types import AppEventRetrieveResponse, AppEventListResponse

Methods:

• client.app_events.retrieve(id) -> AppEventRetrieveResponse
• client.app_events.list(**params) -> AppEventListResponse

Catalog

Types:

from mobilerun_sdk.types.app_events import CatalogRetrieveResponse, CatalogListResponse

Methods:

• client.app_events.catalog.retrieve(app_event_type) -> CatalogRetrieveResponse
• client.app_events.catalog.list() -> CatalogListResponse

Notifications

Types:

from mobilerun_sdk.types import (
    NotificationCatalogResponse,
    NotificationGetPreferencesResponse,
    NotificationUpdatePreferencesResponse,
)

Methods:

• client.notifications.catalog() -> NotificationCatalogResponse
• client.notifications.get_preferences() -> NotificationGetPreferencesResponse
• client.notifications.update_preferences(**params) -> NotificationUpdatePreferencesResponse

Esims

Types:

from mobilerun_sdk.types import (
    EsimCreateResponse,
    EsimRetrieveResponse,
    EsimUpdateResponse,
    EsimListResponse,
    EsimCapacityResponse,
    EsimConfirmPaymentResponse,
    EsimImportResponse,
    EsimInstallResponse,
    EsimInstallStatusResponse,
    EsimSelectorResponse,
)

Methods:

• client.esims.create(**params) -> EsimCreateResponse
• client.esims.retrieve(id) -> EsimRetrieveResponse
• client.esims.update(id, **params) -> EsimUpdateResponse
• client.esims.list(**params) -> EsimListResponse
• client.esims.delete(id) -> None
• client.esims.capacity() -> EsimCapacityResponse
• client.esims.confirm_payment(id) -> EsimConfirmPaymentResponse
• client.esims.import_(**params) -> EsimImportResponse
• client.esims.install(id, **params) -> EsimInstallResponse
• client.esims.install_status(id) -> EsimInstallStatusResponse
• client.esims.selector() -> EsimSelectorResponse

Messages

Types:

from mobilerun_sdk.types.esims import MessageListResponse, MessageSendResponse

Methods:

• client.esims.messages.list(id, **params) -> MessageListResponse
• client.esims.messages.send(id, **params) -> MessageSendResponse

Messages

Types:

from mobilerun_sdk.types import MessageListResponse

Methods:

• client.messages.list(**params) -> MessageListResponse

Conversations

Types:

from mobilerun_sdk.types.messages import ConversationListResponse, ConversationMarkReadResponse

Methods:

• client.messages.conversations.list(**params) -> ConversationListResponse
• client.messages.conversations.mark_read(**params) -> ConversationMarkReadResponse

Numbers

Types:

from mobilerun_sdk.types import (
    NumberCreateResponse,
    NumberRetrieveResponse,
    NumberListResponse,
    NumberDeleteResponse,
    NumberCountriesResponse,
    NumberPurposesResponse,
)

Methods:

• client.numbers.create(**params) -> NumberCreateResponse
• client.numbers.retrieve(id) -> NumberRetrieveResponse
• client.numbers.list(**params) -> NumberListResponse
• client.numbers.delete(id) -> NumberDeleteResponse
• client.numbers.countries() -> NumberCountriesResponse
• client.numbers.purposes() -> NumberPurposesResponse

Messages

Types:

from mobilerun_sdk.types.numbers import MessageListResponse

Methods:

• client.numbers.messages.list(id, **params) -> MessageListResponse

Store

Types:

from mobilerun_sdk.types import StoreCategoriesResponse

Methods:

• client.store.categories() -> StoreCategoriesResponse

Apps

Types:

from mobilerun_sdk.types.store import (
    AppRetrieveResponse,
    AppListResponse,
    AppAddToWorkspaceResponse,
)

Methods:

• client.store.apps.retrieve(app_id) -> AppRetrieveResponse
• client.store.apps.list(**params) -> AppListResponse
• client.store.apps.add_to_workspace(app_id) -> AppAddToWorkspaceResponse