Documentation / app-automate / AppAutomateClient

Class: AppAutomateClient

Defined in: app-automate/src/index.ts:4

Extends

GeneratedAppAutomateClient

Constructors

Constructor

new AppAutomateClient(options?): AppAutomateClient

Defined in: app-automate/src/index.ts:10

Parameters

Parameter	Type
`options?`	`BrowserStackOptions`

Returns

AppAutomateClient

Overrides

GeneratedAppAutomateClient.constructor

Properties

Property	Type	Description	Inherited from	Defined in
`authHeader?`	`string`	HTTP Basic Auth header derived from username and access key.	`GeneratedAppAutomateClient.authHeader`	core/src/api-client.ts:55
`baseUrls`	`object`	Base URLs used for API requests.	`GeneratedAppAutomateClient.baseUrls`	core/src/api-client.ts:53
`baseUrls.sdk`	`string`	-	-	core/src/api-client.ts:53
`baseUrls.sdkCloud`	`string`	-	-	core/src/api-client.ts:53
`clientTimeout?`	`number`	-	`GeneratedAppAutomateClient.clientTimeout`	core/src/api-client.ts:66
`fetchFn`	(`input`, `init?`) => `Promise`<`Response`>	Fetch implementation used to make HTTP requests.	`GeneratedAppAutomateClient.fetchFn`	core/src/api-client.ts:59
`registry`	`CodecRegistry`	Registry of request and response codecs.	`GeneratedAppAutomateClient.registry`	core/src/api-client.ts:61
`userAgent`	`string`	User-Agent string sent with every request.	`GeneratedAppAutomateClient.userAgent`	core/src/api-client.ts:57
`FlutterPlatform`	`object`	-	-	app-automate/src/index.ts:5
`FlutterPlatform.android`	`"android"`	-	-	app-automate/src/index.ts:6
`FlutterPlatform.ios`	`"ios"`	-	-	app-automate/src/index.ts:7

Methods

deleteApp()

deleteApp(appId, options?): Promise<{ success: boolean; }>

Defined in: openapi/generated/app-automate.client.ts:967

Delete an app that was previously uploaded to BrowserStack. Note that apps once deleted cannot be recovered.

Parameters

Parameter	Type	Description
`appId`	`string`	ID of your uploaded app
`options?`	`ExecuteOptions`	Optional abort signal and other request options

Returns

Promise<{ success: boolean; }>

Inherited from

GeneratedAppAutomateClient.deleteApp

deleteBuild()

deleteBuild(buildId, options?): Promise<{ message?: string; status?: string; }>

Defined in: openapi/generated/app-automate.client.ts:487

Delete a build on the server. Please note that deleting a build will delete all the sessions contained within it. Builds once deleted cannot be recovered

Parameters

Parameter	Type	Description
`buildId`	`string`	ID of your build
`options?`	`ExecuteOptions`	Optional abort signal and other request options

Returns

Promise<{ message?: string; status?: string; }>

Inherited from

GeneratedAppAutomateClient.deleteBuild

deleteEspressoApp()

deleteEspressoApp(appId, options?): Promise<{ success: { message: string; }; }>

Defined in: openapi/generated/app-automate.client.ts:1235

Delete an app that was previously uploaded to BrowserStack. Note that apps once deleted cannot be recovered.

Parameters

Parameter	Type	Description
`appId`	`string`	ID of your uploaded app
`options?`	`ExecuteOptions`	Optional abort signal and other request options

Returns

Promise<{ success: { message: string; }; }>

Inherited from

GeneratedAppAutomateClient.deleteEspressoApp

deleteFlutterAndroidApp()

deleteFlutterAndroidApp(appId, options?): Promise<{ success: { message: string; }; }>

Defined in: openapi/generated/app-automate.client.ts:1011

Delete an app that was previously uploaded to BrowserStack. Note that apps once deleted cannot be recovered.

Parameters

Parameter	Type	Description
`appId`	`string`	ID of your uploaded app
`options?`	`ExecuteOptions`	Optional abort signal and other request options

Returns

Promise<{ success: { message: string; }; }>

Inherited from

GeneratedAppAutomateClient.deleteFlutterAndroidApp

deleteFlutteriOSApp()

deleteFlutteriOSApp(appId, options?): Promise<{ success: { message: string; }; }>

Defined in: openapi/generated/app-automate.client.ts:1504

Delete a Flutter iOS test package that was previously uploaded to BrowserStack. Note that apps once deleted cannot be recovered.

Parameters

Parameter	Type	Description
`appId`	`string`	Test package ID of your app
`options?`	`ExecuteOptions`	Optional abort signal and other request options

Returns

Promise<{ success: { message: string; }; }>

Inherited from

GeneratedAppAutomateClient.deleteFlutteriOSApp

deleteMediaFile()

deleteMediaFile(mediaId, options?): Promise<{ success: boolean; }>

Defined in: openapi/generated/app-automate.client.ts:1191

Fetches list of recently uploaded media files for the entire group

Parameters

Parameter	Type	Description
`mediaId`	`string`	ID of your media file
`options?`	`ExecuteOptions`	Optional abort signal and other request options

Returns

Promise<{ success: boolean; }>

Inherited from

GeneratedAppAutomateClient.deleteMediaFile

deleteProject()

deleteProject(projectId, options?): Promise<{ message?: string; status?: string; }>

Defined in: openapi/generated/app-automate.client.ts:901

Delete a project on the server using the DELETE method. Please note that to delete a project, it needs to be empty of builds and sessions, and projects once deleted cannot be recovered

Parameters

Parameter	Type	Description
`projectId`	`string`	ID of your project
`options?`	`ExecuteOptions`	Optional abort signal and other request options

Returns

Promise<{ message?: string; status?: string; }>

Inherited from

GeneratedAppAutomateClient.deleteProject

deleteSession()

deleteSession(sessionId, options?): Promise<{ message?: string; status?: string; }>

Defined in: openapi/generated/app-automate.client.ts:1145

Delete a session on the server. Sessions once deleted cannot be recovered

Parameters

Parameter	Type	Description
`sessionId`	`string`	ID of your session
`options?`	`ExecuteOptions`	Optional abort signal and other request options

Returns

Promise<{ message?: string; status?: string; }>

Inherited from

GeneratedAppAutomateClient.deleteSession

deleteXCUITestApp()

deleteXCUITestApp(appId, options?): Promise<{ success: { message: string; }; }>

Defined in: openapi/generated/app-automate.client.ts:618

Delete an app that was previously uploaded to BrowserStack. Note that apps once deleted cannot be recovered.

Parameters

Parameter	Type	Description
`appId`	`string`	ID of your uploaded app
`options?`	`ExecuteOptions`	Optional abort signal and other request options

Returns

Promise<{ success: { message: string; }; }>

Inherited from

GeneratedAppAutomateClient.deleteXCUITestApp

execute()

protected execute<T>(spec): Promise<T>

Defined in: core/src/api-client.ts:126

Internal

Type Parameters

Type Parameter	Default type
`T`	`unknown`

Parameters

Parameter	Type
`spec`	{[`key`: `string`]: `unknown`; `baseUrl?`: `"sdk"` \| `"sdkCloud"`; `method`: `HttpMethod`; `operationId`: `string`; `params?`: { `path?`: `Record`<`string`, `unknown`>; `query?`: `Record`<`string`, `unknown`>; }; `path`: `string`; `requestCodec?`: `string`; `requestCodecConfig?`: `unknown`; `requestInput?`: `unknown`; `responseCodec`: `string`; `responseCodecConfig`: `unknown`; `signal?`: `AbortSignal`; }
`spec.baseUrl?`	`"sdk"` \| `"sdkCloud"`
`spec.method`	`HttpMethod`
`spec.operationId`	`string`
`spec.params?`	{ `path?`: `Record`<`string`, `unknown`>; `query?`: `Record`<`string`, `unknown`>; }
`spec.params.path?`	`Record`<`string`, `unknown`>
`spec.params.query?`	`Record`<`string`, `unknown`>
`spec.path`	`string`
`spec.requestCodec?`	`string`
`spec.requestCodecConfig?`	`unknown`
`spec.requestInput?`	`unknown`
`spec.responseCodec`	`string`
`spec.responseCodecConfig`	`unknown`
`spec.signal?`	`AbortSignal`

Returns

Promise<T>

Inherited from

GeneratedAppAutomateClient.execute

getAppiumLogs()

getAppiumLogs(buildId, sessionId, options?): Promise<string>

Defined in: openapi/generated/app-automate.client.ts:945

Access the Appium logs for your session. These are logs generated by the Appium server and contain the details about your each Appium command execution in the test session. You can troubleshoot any errors in case your test session failed.

Parameters

Parameter	Type	Description
`buildId`	`string`	ID of your build
`sessionId`	`string`	ID of your session
`options?`	`ExecuteOptions`	Optional abort signal and other request options

Returns

Promise<string>

Inherited from

GeneratedAppAutomateClient.getAppiumLogs

getAppProfilingDataV1()

getAppProfilingDataV1(buildId, sessionId, options?): Promise<object[]>

Defined in: openapi/generated/app-automate.client.ts:1435

Access the app profiling logs to view the resource consumption (CPU, memory, battery, and network) by your app on the device. The logs are only available for Android.

Parameters

Parameter	Type	Description
`buildId`	`string`	ID of your build
`sessionId`	`string`	ID of your session
`options?`	`ExecuteOptions`	Optional abort signal and other request options

Returns

Promise<object[]>

Inherited from

GeneratedAppAutomateClient.getAppProfilingDataV1

getAppProfilingDataV2()

getAppProfilingDataV2(buildId, sessionId, options?): Promise<{ appSizeInstalled?: number; batteryLevel?: number; cpuUsage?: number; memoryUsage?: number; networkReceived?: number; networkSent?: number; timestamp?: string; uiRendering?: number; }>

Defined in: openapi/generated/app-automate.client.ts:1079

Access the detailed app profling metrics such as installed app size, UI rendering metrics, resource consumption metrics, etc.

Parameters

Parameter	Type	Description
`buildId`	`string`	ID of your build
`sessionId`	`string`	ID of your session
`options?`	`ExecuteOptions`	Optional abort signal and other request options

Returns

Promise<{ appSizeInstalled?: number; batteryLevel?: number; cpuUsage?: number; memoryUsage?: number; networkReceived?: number; networkSent?: number; timestamp?: string; uiRendering?: number; }>

Inherited from

GeneratedAppAutomateClient.getAppProfilingDataV2

getApps()

getApps(options?): Promise<DeepCamelCase<{ message: string; } | object[]>>

Defined in: openapi/generated/app-automate.client.ts:553

Fetches list of recently uploaded apps

Parameters

Parameter	Type	Description
`options?`	`ExecuteOptions`	Optional abort signal and other request options

Returns

Promise<DeepCamelCase<{ message: string; } | object[]>>

Inherited from

GeneratedAppAutomateClient.getApps

getAppsByCustomId()

getAppsByCustomId(customId, options?): Promise<DeepCamelCase<object[] | { message: string; }>>

Defined in: openapi/generated/app-automate.client.ts:1365

Fetches list of uploaded apps by custom ID

Parameters

Parameter	Type	Description
`customId`	`string`	Custom ID of your app
`options?`	`ExecuteOptions`	Optional abort signal and other request options

Returns

Promise<DeepCamelCase<object[] | { message: string; }>>

Inherited from

GeneratedAppAutomateClient.getAppsByCustomId

getBuild()

getBuild(buildId, options?): Promise<{ automationBuild: { automationProjectId?: number; buildTag: string; duration: number; groupId?: number; hashedId: string; name: string; publicUrl: string; status: "done" | "running" | "timeout" | "failed"; subGroupId?: number; userId?: number; }; sessions: object[]; }>

Defined in: openapi/generated/app-automate.client.ts:443

Fetches a build

Parameters

Parameter	Type	Description
`buildId`	`string`	ID of your build
`options?`	`ExecuteOptions`	Optional abort signal and other request options

Returns

Promise<{ automationBuild: { automationProjectId?: number; buildTag: string; duration: number; groupId?: number; hashedId: string; name: string; publicUrl: string; status: "done" | "running" | "timeout" | "failed"; subGroupId?: number; userId?: number; }; sessions: object[]; }>

Inherited from

GeneratedAppAutomateClient.getBuild

getBuilds()

getBuilds(projectId?, limit?, offset?, status?, options?): Promise<GetAppAutomateBuildsResult>

Defined in: openapi/generated/app-automate.client.ts:1460

Fetch the 10 recent test builds that have run on BrowserStack. You can also limit the number of builds and paginate through your data

Parameters

Parameter	Type	Description
`projectId?`	`string`	ID of your project
`limit?`	`string`	Specify the number of results to be displayed. The default value is 10, and the maximum value is 100
`offset?`	`string`	Retrieve builds from a specific point using the offset parameter
`status?`	`string`	Status of the build
`options?`	`ExecuteOptions`	Optional abort signal and other request options

Returns

Promise<GetAppAutomateBuildsResult>

Inherited from

GeneratedAppAutomateClient.getBuilds

getDeviceLogs()

getDeviceLogs(buildId, sessionId, options?): Promise<string>

Defined in: openapi/generated/app-automate.client.ts:1412

Access the device logs for your session. These are system logs specific to your application generated by the OS(Android/iOS) and can be helpful for debugging any application crashes during test execution.

Parameters

Parameter	Type	Description
`buildId`	`string`	ID of your build
`sessionId`	`string`	ID of your session
`options?`	`ExecuteOptions`	Optional abort signal and other request options

Returns

Promise<string>

Inherited from

GeneratedAppAutomateClient.getDeviceLogs

getDevices()

getDevices(options?): Promise<object[]>

Defined in: openapi/generated/app-automate.client.ts:922

Fetches list of devices supported by App Automate

Parameters

Parameter	Type	Description
`options?`	`ExecuteOptions`	Optional abort signal and other request options

Returns

Promise<object[]>

Inherited from

GeneratedAppAutomateClient.getDevices

getEspressoApp()

getEspressoApp(appId, options?): Promise<{ appId?: string; appName?: string; appUrl: string; appVersion?: string; customId?: string; expiry?: string; shareableId?: string; uploadedAt?: string; }>

Defined in: openapi/generated/app-automate.client.ts:1213

Get details of an uploaded Espresso app

Parameters

Parameter	Type	Description
`appId`	`string`	App ID of your app
`options?`	`ExecuteOptions`	Optional abort signal and other request options

Returns

Promise<{ appId?: string; appName?: string; appUrl: string; appVersion?: string; customId?: string; expiry?: string; shareableId?: string; uploadedAt?: string; }>

Inherited from

GeneratedAppAutomateClient.getEspressoApp

getEspressoApps()

getEspressoApps(scope?, customId?, limit?, options?): Promise<object[]>

Defined in: openapi/generated/app-automate.client.ts:1056

Fetches list of recently uploaded Espresso apps

Parameters

Parameter	Type	Description
`scope?`	`string`	Show recent apps at a group level or user level.
`customId?`	`string`	Filter recently uploaded apps by custom ID. Accepted characters are A-Z, a-z, 0-9, ., -, _. All other characters are ignored. Character limit is 100.
`limit?`	`string`	Number of recent apps to be fetched. Default is 10.
`options?`	`ExecuteOptions`	Optional abort signal and other request options

Returns

Promise<object[]>

Inherited from

GeneratedAppAutomateClient.getEspressoApps

getFlutterAndroidApp()

getFlutterAndroidApp(appId, options?): Promise<{ appId?: string; appName?: string; appUrl: string; appVersion?: string; customId?: string; expiry?: string; shareableId?: string; uploadedAt?: string; }>

Defined in: openapi/generated/app-automate.client.ts:989

Get details of an uploaded Flutter app

Parameters

Parameter	Type	Description
`appId`	`string`	App ID of your app
`options?`	`ExecuteOptions`	Optional abort signal and other request options

Returns

Promise<{ appId?: string; appName?: string; appUrl: string; appVersion?: string; customId?: string; expiry?: string; shareableId?: string; uploadedAt?: string; }>

Inherited from

GeneratedAppAutomateClient.getFlutterAndroidApp

getFlutterAndroidApps()

getFlutterAndroidApps(scope?, customId?, limit?, options?): Promise<object[]>

Defined in: openapi/generated/app-automate.client.ts:1389

Fetches list of recently uploaded Flutter apps

Parameters

Parameter	Type	Description
`scope?`	`string`	Show recent apps at a group level or user level.
`customId?`	`string`	Filter recently uploaded apps by custom ID. Accepted characters are A-Z, a-z, 0-9, ., -, _. All other characters are ignored. Character limit is 100.
`limit?`	`string`	Number of recent apps to be fetched. Default is 10.
`options?`	`ExecuteOptions`	Optional abort signal and other request options

Returns

Promise<object[]>

Inherited from

GeneratedAppAutomateClient.getFlutterAndroidApps

getFlutteriOSApp()

getFlutteriOSApp(appId, options?): Promise<{ customId?: string; shareableId?: string; testPackageId?: string; testPackageName?: string; testPackageUrl: string; uploadedAt?: string; }>

Defined in: openapi/generated/app-automate.client.ts:1482

Get details of an uploaded Flutter iOS test package

Parameters

Parameter	Type	Description
`appId`	`string`	Test package ID of your app
`options?`	`ExecuteOptions`	Optional abort signal and other request options

Returns

Promise<{ customId?: string; shareableId?: string; testPackageId?: string; testPackageName?: string; testPackageUrl: string; uploadedAt?: string; }>

Inherited from

GeneratedAppAutomateClient.getFlutteriOSApp

getFlutteriOSApps()

getFlutteriOSApps(scope?, customId?, limit?, options?): Promise<object[]>

Defined in: openapi/generated/app-automate.client.ts:1280

Fetches list of recently uploaded Flutter iOS test packages

Parameters

Parameter	Type	Description
`scope?`	`string`	Show recent apps at a group level or user level.
`customId?`	`string`	Filter recently uploaded apps by custom ID. Accepted characters are A-Z, a-z, 0-9, ., -, _. All other characters are ignored. Character limit is 100.
`limit?`	`string`	Number of recent apps to be fetched. Default is 10.
`options?`	`ExecuteOptions`	Optional abort signal and other request options

Returns

Promise<object[]>

Inherited from

GeneratedAppAutomateClient.getFlutteriOSApps

getGroupApps()

getGroupApps(options?): Promise<DeepCamelCase<object[] | { message: string; }>>

Defined in: openapi/generated/app-automate.client.ts:1322

Fetches list of recently uploaded apps for the entire group

Parameters

Parameter	Type	Description
`options?`	`ExecuteOptions`	Optional abort signal and other request options

Returns

Promise<DeepCamelCase<object[] | { message: string; }>>

Inherited from

GeneratedAppAutomateClient.getGroupApps

getGroupMediaFiles()

getGroupMediaFiles(options?): Promise<DeepCamelCase<object[] | { message: string; }>>

Defined in: openapi/generated/app-automate.client.ts:574

Fetches list of recently uploaded media files for the entire group

Parameters

Parameter	Type	Description
`options?`	`ExecuteOptions`	Optional abort signal and other request options

Returns

Promise<DeepCamelCase<object[] | { message: string; }>>

Inherited from

GeneratedAppAutomateClient.getGroupMediaFiles

getMediaFiles()

getMediaFiles(options?): Promise<DeepCamelCase<object[] | { message: string; }>>

Defined in: openapi/generated/app-automate.client.ts:1256

Fetches list of recently uploaded media files

Parameters

Parameter	Type	Description
`options?`	`ExecuteOptions`	Optional abort signal and other request options

Returns

Promise<DeepCamelCase<object[] | { message: string; }>>

Inherited from

GeneratedAppAutomateClient.getMediaFiles

getMediaFilesByCustomId()

getMediaFilesByCustomId(customId, options?): Promise<DeepCamelCase<{ message: string; } | object[]>>

Defined in: openapi/generated/app-automate.client.ts:509

Fetches list of recently uploaded media files by custom ID

Parameters

Parameter	Type	Description
`customId`	`string`	Filter recently uploaded media files by custom ID.
`options?`	`ExecuteOptions`	Optional abort signal and other request options

Returns

Promise<DeepCamelCase<{ message: string; } | object[]>>

Inherited from

GeneratedAppAutomateClient.getMediaFilesByCustomId

getNetworkLogs()

getNetworkLogs(buildId, sessionId, options?): Promise<{[key: string]: never; }>

Defined in: openapi/generated/app-automate.client.ts:641

Access the network logs for your session. These logs capture network data such as network traffic, latency, HTTP requests/responses in the HAR (HTTP Archive) format. You can identify any performance bottlenecks or debug failed REST API responses. Network logs are disabled by default.

Parameters

Parameter	Type	Description
`buildId`	`string`	ID of your build
`sessionId`	`string`	ID of your session
`options?`	`ExecuteOptions`	Optional abort signal and other request options

Returns

Promise<{[key: string]: never; }>

Inherited from

GeneratedAppAutomateClient.getNetworkLogs

getPlan()

getPlan(options?): Promise<{ automatePlan: string; parallelSessionsMaxAllowed: number; parallelSessionsRunning: number; queuedSessions: number; queuedSessionsMaxAllowed: number; teamParallelSessionsMaxAllowed: number; terminalAccess?: string; }>

Defined in: openapi/generated/app-automate.client.ts:772

Fetches App Automate plan details

Parameters

Parameter	Type	Description
`options?`	`ExecuteOptions`	Optional abort signal and other request options

Returns

Promise<{ automatePlan: string; parallelSessionsMaxAllowed: number; parallelSessionsRunning: number; queuedSessions: number; queuedSessionsMaxAllowed: number; teamParallelSessionsMaxAllowed: number; terminalAccess?: string; }>

Inherited from

GeneratedAppAutomateClient.getPlan

getProject()

getProject(projectId, options?): Promise<{ builds: object[]; createdAt: string; groupId: number; id: number; name: string; subGroupId: number; updatedAt: string; userId: number; }>

Defined in: openapi/generated/app-automate.client.ts:857

Specific information about a particular project can be queried using the project ID

Parameters

Parameter	Type	Description
`projectId`	`string`	ID of your project
`options?`	`ExecuteOptions`	Optional abort signal and other request options

Returns

Promise<{ builds: object[]; createdAt: string; groupId: number; id: number; name: string; subGroupId: number; updatedAt: string; userId: number; }>

Inherited from

GeneratedAppAutomateClient.getProject

getProjectBadgeKey()

getProjectBadgeKey(projectId, options?): Promise<string>

Defined in: openapi/generated/app-automate.client.ts:1526

Fetches the badge key for sharing a public link for the Automate dashboard to view the latest build and sessions for that project

Parameters

Parameter	Type	Description
`projectId`	`string`	ID of your project
`options?`	`ExecuteOptions`	Optional abort signal and other request options

Returns

Promise<string>

Inherited from

GeneratedAppAutomateClient.getProjectBadgeKey

getProjects()

getProjects(limit?, offset?, status?, options?): Promise<object[]>

Defined in: openapi/generated/app-automate.client.ts:1169

Fetch the last 10 projects or your BrowserStack group. You can also limit the number of projects and paginate through your data

Parameters

Parameter	Type	Description
`limit?`	`string`	Specify the number of results to be displayed. The default value is 10, and the maximum value is 100
`offset?`	`string`	Retrieve projects from a specific point using the offset parameter
`status?`	`string`	Status of the build
`options?`	`ExecuteOptions`	Optional abort signal and other request options

Returns

Promise<object[]>

Inherited from

GeneratedAppAutomateClient.getProjects

getSession()

getSession(sessionId, options?): Promise<{ appDetails: { appCustomId?: string; appName?: string; appUrl?: string; appVersion?: string; uploadedAt?: string; }; appiumLogsUrl: string; browser: string; browserConsoleLogsUrl: string; browserstackStatus: string; browserUrl: string; browserVersion: string; buildName: string; createdAt: string; device?: string; duration: number; harLogsUrl: string; hashedId: string; logs: string; name: string; os: string; osVersion: string; projectName: string; publicUrl: string; realMobile?: boolean; reason: string; seleniumLogsUrl: string; seleniumTelemetryLogsUrl: string; status: "done" | "running" | "timeout" | "failed"; videoUrl: string; }>

Defined in: openapi/generated/app-automate.client.ts:1101

Get details of a test session including its status and debugging information such as Appium logs and test video recording

Parameters

Parameter	Type	Description
`sessionId`	`string`	ID of your session
`options?`	`ExecuteOptions`	Optional abort signal and other request options

Returns

Promise<{ appDetails: { appCustomId?: string; appName?: string; appUrl?: string; appVersion?: string; uploadedAt?: string; }; appiumLogsUrl: string; browser: string; browserConsoleLogsUrl: string; browserstackStatus: string; browserUrl: string; browserVersion: string; buildName: string; createdAt: string; device?: string; duration: number; harLogsUrl: string; hashedId: string; logs: string; name: string; os: string; osVersion: string; projectName: string; publicUrl: string; realMobile?: boolean; reason: string; seleniumLogsUrl: string; seleniumTelemetryLogsUrl: string; status: "done" | "running" | "timeout" | "failed"; videoUrl: string; }>

Inherited from

GeneratedAppAutomateClient.getSession

getSessionLogs()

getSessionLogs(buildId, sessionId, options?): Promise<string>

Defined in: openapi/generated/app-automate.client.ts:532

Access the logs for the session in textual format. It includes information about the test session’s desired capabilities and detailed information about every request and response. You can view all the steps executed in the test and troubleshoot errors for any failed steps.

Parameters

Parameter	Type	Description
`buildId`	`string`	ID of your build
`sessionId`	`string`	ID of your session
`options?`	`ExecuteOptions`	Optional abort signal and other request options

Returns

Promise<string>

Inherited from

GeneratedAppAutomateClient.getSessionLogs

getXCUITestApp()

getXCUITestApp(appId, options?): Promise<{ appId?: string; appName?: string; appUrl: string; appVersion?: string; customId?: string; expiry?: string; shareableId?: string; uploadedAt?: string; }>

Defined in: openapi/generated/app-automate.client.ts:596

Get details of an uploaded XCUITest app

Parameters

Parameter	Type	Description
`appId`	`string`	App ID of your app
`options?`	`ExecuteOptions`	Optional abort signal and other request options

Returns

Promise<{ appId?: string; appName?: string; appUrl: string; appVersion?: string; customId?: string; expiry?: string; shareableId?: string; uploadedAt?: string; }>

Inherited from

GeneratedAppAutomateClient.getXCUITestApp

getXCUITestApps()

getXCUITestApps(scope?, customId?, limit?, options?): Promise<object[]>

Defined in: openapi/generated/app-automate.client.ts:729

Fetches list of recently uploaded XCUITest apps

Parameters

Parameter	Type	Description
`scope?`	`string`	Show recent apps at a group level or user level.
`customId?`	`string`	Filter recently uploaded apps by custom ID. Accepted characters are A-Z, a-z, 0-9, ., -, _. All other characters are ignored. Character limit is 100.
`limit?`	`string`	Number of recent apps to be fetched. Default is 10.
`options?`	`ExecuteOptions`	Optional abort signal and other request options

Returns

Promise<object[]>

Inherited from

GeneratedAppAutomateClient.getXCUITestApps

updateBuild()

updateBuild(buildId, body, options?): Promise<DeepCamelCase<{ automation_build: { automation_project_id?: number; build_tag: string; duration: number; group_id?: number; hashed_id: string; name: string; public_url: string; status: "done" | "running" | "timeout" | "failed"; sub_group_id?: number; user_id?: number; }; } | { error: string; }>>

Defined in: openapi/generated/app-automate.client.ts:465

Update the tag of your build after the build is complete. To delete a build tag, simply pass an empty string as value for build_tag.

Parameters

Parameter	Type	Description
`buildId`	`string`	ID of your build
`body`	{ `buildTag`: `string`; }	-
`body.buildTag`	`string`	-
`options?`	`ExecuteOptions`	Optional abort signal and other request options

Returns

Promise<DeepCamelCase<{ automation_build: { automation_project_id?: number; build_tag: string; duration: number; group_id?: number; hashed_id: string; name: string; public_url: string; status: "done" | "running" | "timeout" | "failed"; sub_group_id?: number; user_id?: number; }; } | { error: string; }>>

Inherited from

GeneratedAppAutomateClient.updateBuild

updateProject()

updateProject(projectId, body, options?): Promise<{ createdAt: string; groupId: number; id: number; name: string; subGroupId: number; updatedAt: string; userId: number; }>

Defined in: openapi/generated/app-automate.client.ts:879

Update the name of your project after the project is complete

Parameters

Parameter	Type	Description
`projectId`	`string`	ID of your project
`body`	{ `name`: `string`; }	-
`body.name`	`string`	-
`options?`	`ExecuteOptions`	Optional abort signal and other request options

Returns

Promise<{ createdAt: string; groupId: number; id: number; name: string; subGroupId: number; updatedAt: string; userId: number; }>

Inherited from

GeneratedAppAutomateClient.updateProject

updateSession()

updateSession(sessionId, body, options?): Promise<{ appDetails: { appCustomId?: string; appName?: string; appUrl?: string; appVersion?: string; uploadedAt?: string; }; appiumLogsUrl: string; browser: string; browserConsoleLogsUrl: string; browserstackStatus: string; browserUrl: string; browserVersion: string; buildName: string; createdAt: string; device?: string; duration: number; harLogsUrl: string; hashedId: string; logs: string; name: string; os: string; osVersion: string; projectName: string; publicUrl: string; realMobile?: boolean; reason: string; seleniumLogsUrl: string; seleniumTelemetryLogsUrl: string; status: "done" | "running" | "timeout" | "failed"; videoUrl: string; }>

Defined in: openapi/generated/app-automate.client.ts:1123

Set the status for a session. You can mark test status as passed or failed along with a reason.

Parameters

Parameter	Type	Description
`sessionId`	`string`	ID of your session
`body`	{ `reason`: `string`; `status`: `"failed"` \| `"passed"`; }	-
`body.reason`	`string`	-
`body.status?`	`"failed"` \| `"passed"`	-
`options?`	`ExecuteOptions`	Optional abort signal and other request options

Returns

Inherited from

GeneratedAppAutomateClient.updateSession

uploadApp()

uploadApp(body, options?): Promise<{ appId?: string; appName?: string; appUrl: string; appVersion?: string; customId?: string; expiry?: string; shareableId?: string; uploadedAt?: string; }>

Defined in: openapi/generated/app-automate.client.ts:1301

Upload the application under test (AUT) for Appium testing.

Parameters

Parameter	Type	Description
`body`	{ `file`: `Blob`; } \| { `url`: `string`; } & `object` & `Record`<`string`, `unknown`>	-
`options?`	`ExecuteOptions`	Optional abort signal and other request options

Returns

Promise<{ appId?: string; appName?: string; appUrl: string; appVersion?: string; customId?: string; expiry?: string; shareableId?: string; uploadedAt?: string; }>

Inherited from

GeneratedAppAutomateClient.uploadApp

uploadBuildTerminalLogs()

uploadBuildTerminalLogs(buildId, body, options?): Promise<string>

Defined in: openapi/generated/app-automate.client.ts:663

Upload terminal logs for your build.

Parameters

Parameter	Type	Description
`buildId`	`string`	ID of your build
`body`	{ `file`: `Blob`; } \| { `url`: `string`; } & `object` & `Record`<`string`, `unknown`>	-
`options?`	`ExecuteOptions`	Optional abort signal and other request options

Returns

Promise<string>

Inherited from

GeneratedAppAutomateClient.uploadBuildTerminalLogs

uploadDetoxAndroidApp()

uploadDetoxAndroidApp(body, options?): Promise<{ appId?: string; appName?: string; appUrl: string; appVersion?: string; customId?: string; expiry?: string; shareableId?: string; uploadedAt?: string; }>

Defined in: openapi/generated/app-automate.client.ts:705

Upload the application under test (AUT) for Detox Android testing.

Parameters

Parameter	Type	Description
`body`	{ `file`: `Blob`; } \| { `url`: `string`; } & `object` & `Record`<`string`, `unknown`>	-
`options?`	`ExecuteOptions`	Optional abort signal and other request options

Returns

Promise<{ appId?: string; appName?: string; appUrl: string; appVersion?: string; customId?: string; expiry?: string; shareableId?: string; uploadedAt?: string; }>

Inherited from

GeneratedAppAutomateClient.uploadDetoxAndroidApp

uploadDetoxAndroidAppClient()

uploadDetoxAndroidAppClient(body, options?): Promise<{ appId?: string; appName?: string; appUrl: string; appVersion?: string; customId?: string; expiry?: string; shareableId?: string; uploadedAt?: string; }>

Defined in: openapi/generated/app-automate.client.ts:814

Upload the app client under test for Detox Android testing.

Parameters

Parameter	Type	Description
`body`	{ `file`: `Blob`; } \| { `url`: `string`; } & `object` & `Record`<`string`, `unknown`>	-
`options?`	`ExecuteOptions`	Optional abort signal and other request options

Returns

Promise<{ appId?: string; appName?: string; appUrl: string; appVersion?: string; customId?: string; expiry?: string; shareableId?: string; uploadedAt?: string; }>

Inherited from

GeneratedAppAutomateClient.uploadDetoxAndroidAppClient

uploadEspressoApp()

uploadEspressoApp(body, options?): Promise<{ appId?: string; appName?: string; appUrl: string; appVersion?: string; customId?: string; expiry?: string; shareableId?: string; uploadedAt?: string; }>

Defined in: openapi/generated/app-automate.client.ts:1343

Upload the application under test (AUT) for Espresso testing.

Parameters

Parameter	Type	Description
`body`	{ `file`: `Blob`; } \| { `url`: `string`; } & `object` & `Record`<`string`, `unknown`>	-
`options?`	`ExecuteOptions`	Optional abort signal and other request options

Returns

Promise<{ appId?: string; appName?: string; appUrl: string; appVersion?: string; customId?: string; expiry?: string; shareableId?: string; uploadedAt?: string; }>

Inherited from

GeneratedAppAutomateClient.uploadEspressoApp

uploadFlutterAndroidApp()

uploadFlutterAndroidApp(body, options?): Promise<{ appId?: string; appName?: string; appUrl: string; appVersion?: string; customId?: string; expiry?: string; shareableId?: string; uploadedAt?: string; }>

Defined in: openapi/generated/app-automate.client.ts:684

Upload the application under test (AUT) for Flutter testing.

Parameters

Parameter	Type	Description
`body`	{ `file`: `Blob`; } \| { `url`: `string`; } & `object` & `Record`<`string`, `unknown`>	-
`options?`	`ExecuteOptions`	Optional abort signal and other request options

Returns

Promise<{ appId?: string; appName?: string; appUrl: string; appVersion?: string; customId?: string; expiry?: string; shareableId?: string; uploadedAt?: string; }>

Inherited from

GeneratedAppAutomateClient.uploadFlutterAndroidApp

uploadFlutteriOSApp()

uploadFlutteriOSApp(body, options?): Promise<{ customId?: string; shareableId?: string; testPackageId?: string; testPackageName?: string; testPackageUrl: string; uploadedAt?: string; }>

Defined in: openapi/generated/app-automate.client.ts:793

Upload the application under test (AUT) for Flutter iOS testing in .zip format.

Parameters

Parameter	Type	Description
`body`	{ `file`: `Blob`; } \| { `url`: `string`; } & `object` & `Record`<`string`, `unknown`>	-
`options?`	`ExecuteOptions`	Optional abort signal and other request options

Returns

Promise<{ customId?: string; shareableId?: string; testPackageId?: string; testPackageName?: string; testPackageUrl: string; uploadedAt?: string; }>

Inherited from

GeneratedAppAutomateClient.uploadFlutteriOSApp

uploadMediaFile()

uploadMediaFile(body, options?): Promise<{ customId?: string; mediaId: string; mediaName?: string; mediaUrl: string; shareableId?: string; uploadedAt?: string; }>

Defined in: openapi/generated/app-automate.client.ts:1032

Upload a media file you want to use in your tests

Parameters

Parameter	Type	Description
`body`	{ `file`: `Blob`; } \| { `url`: `string`; } & `object` & `Record`<`string`, `unknown`>	-
`options?`	`ExecuteOptions`	Optional abort signal and other request options

Returns

Promise<{ customId?: string; mediaId: string; mediaName?: string; mediaUrl: string; shareableId?: string; uploadedAt?: string; }>

Inherited from

GeneratedAppAutomateClient.uploadMediaFile

uploadSessionTerminalLogs()

uploadSessionTerminalLogs(sessionId, body, options?): Promise<string>

Defined in: openapi/generated/app-automate.client.ts:751

Upload terminal logs for your session.

Parameters

Parameter	Type	Description
`sessionId`	`string`	ID of your session
`body`	{ `file`: `Blob`; } \| { `url`: `string`; } & `object` & `Record`<`string`, `unknown`>	-
`options?`	`ExecuteOptions`	Optional abort signal and other request options

Returns

Promise<string>

Inherited from

GeneratedAppAutomateClient.uploadSessionTerminalLogs

uploadXCUITestApp()

uploadXCUITestApp(body, options?): Promise<{ appId?: string; appName?: string; appUrl: string; appVersion?: string; customId?: string; expiry?: string; shareableId?: string; uploadedAt?: string; }>

Defined in: openapi/generated/app-automate.client.ts:835

Upload the application under test (AUT) for XCUITest testing.

Parameters

Parameter	Type	Description
`body`	{ `file`: `Blob`; } \| { `url`: `string`; } & `object` & `Record`<`string`, `unknown`>	-
`options?`	`ExecuteOptions`	Optional abort signal and other request options

Returns

Promise<{ appId?: string; appName?: string; appUrl: string; appVersion?: string; customId?: string; expiry?: string; shareableId?: string; uploadedAt?: string; }>

Inherited from

GeneratedAppAutomateClient.uploadXCUITestApp

Class: AppAutomateClient ​

Extends ​

Constructors ​

Constructor ​

Parameters ​

Returns ​

Overrides ​

Properties ​

Methods ​

deleteApp() ​

Parameters ​

Returns ​

Inherited from ​

deleteBuild() ​

Parameters ​

Returns ​

Inherited from ​

deleteEspressoApp() ​

Parameters ​

Returns ​

Inherited from ​

deleteFlutterAndroidApp() ​

Parameters ​

Returns ​

Inherited from ​

deleteFlutteriOSApp() ​

Parameters ​

Returns ​

Inherited from ​

deleteMediaFile() ​

Parameters ​

Returns ​

Inherited from ​

deleteProject() ​

Parameters ​

Returns ​

Inherited from ​

deleteSession() ​

Parameters ​

Returns ​

Inherited from ​

deleteXCUITestApp() ​

Parameters ​

Returns ​

Inherited from ​

execute() ​

Type Parameters ​

Parameters ​

Returns ​

Inherited from ​

getAppiumLogs() ​

Parameters ​

Returns ​

Inherited from ​

getAppProfilingDataV1() ​

Parameters ​

Returns ​

Inherited from ​

getAppProfilingDataV2() ​

Parameters ​

Returns ​

Inherited from ​

getApps() ​

Parameters ​

Returns ​

Inherited from ​

getAppsByCustomId() ​

Parameters ​

Returns ​

Inherited from ​

getBuild() ​

Parameters ​

Returns ​

Inherited from ​

getBuilds() ​

Parameters ​

Returns ​

Inherited from ​

getDeviceLogs() ​

Parameters ​

Class: AppAutomateClient

Extends

Constructors

Constructor

Parameters

Returns

Overrides

Properties

Methods

deleteApp()

Parameters

Returns

Inherited from

deleteBuild()

Parameters

Returns

Inherited from

deleteEspressoApp()

Parameters

Returns

Inherited from

deleteFlutterAndroidApp()

Parameters

Returns

Inherited from

deleteFlutteriOSApp()

Parameters

Returns

Inherited from

deleteMediaFile()

Parameters

Returns

Inherited from

deleteProject()

Parameters

Returns

Inherited from

deleteSession()

Parameters

Returns

Inherited from

deleteXCUITestApp()

Parameters

Returns

Inherited from

execute()

Type Parameters

Parameters

Returns

Inherited from

getAppiumLogs()

Parameters

Returns

Inherited from

getAppProfilingDataV1()

Parameters

Returns

Inherited from

getAppProfilingDataV2()

Parameters

Returns

Inherited from

getApps()

Parameters

Returns

Inherited from

getAppsByCustomId()

Parameters

Returns

Inherited from

getBuild()

Parameters

Returns

Inherited from

getBuilds()

Parameters

Returns

Inherited from

getDeviceLogs()

Parameters