Documentation / test-reporting / TestReportingClient

Class: TestReportingClient

Defined in: test-reporting/src/index.ts:4

Extends

• GeneratedTestReportingClient

Constructors

Constructor

new TestReportingClient(options?): TestReportingClient

Defined in: test-reporting/src/index.ts:5

Parameters

Parameter	Type
options?	BrowserStackOptions & object

Returns

TestReportingClient

Overrides

GeneratedTestReportingClient.constructor

Properties

Property	Type	Description	Inherited from	Defined in
authHeader?	string	HTTP Basic Auth header derived from username and access key.	GeneratedTestReportingClient.authHeader	core/src/api-client.ts:55
baseUrls	object	Base URLs used for API requests.	GeneratedTestReportingClient.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	-	GeneratedTestReportingClient.clientTimeout	core/src/api-client.ts:66
fetchFn	(input, init?) => Promise<Response>	Fetch implementation used to make HTTP requests.	GeneratedTestReportingClient.fetchFn	core/src/api-client.ts:59
registry	CodecRegistry	Registry of request and response codecs.	GeneratedTestReportingClient.registry	core/src/api-client.ts:61
userAgent	string	User-Agent string sent with every request.	GeneratedTestReportingClient.userAgent	core/src/api-client.ts:57

Methods

addBuildLogs()

addBuildLogs(buildHashedId, body, options?): Promise<{ message?: string; success?: boolean; }>

Defined in: openapi/generated/test-reporting.client.ts:290

Add Build Logs (ingestion)

Parameters

Parameter	Type	Description
buildHashedId	string	-
body	{ logs: object[]; }	-
body.logs	object[]	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

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

Inherited from

GeneratedTestReportingClient.addBuildLogs

---

createQualityGateProfile()

createQualityGateProfile(projectName, body, options?): Promise<{ success?: boolean; uuid?: string; }>

Defined in: openapi/generated/test-reporting.client.ts:416

Create Quality Gate Profile

Parameters

Parameter	Type	Description
projectName	string	-
body	{ applicableBuilds?: { allBuilds?: boolean; buildNames?: string[]; buildTags?: string[]; }; enabled: boolean; hooksVisibility?: "failed" | "none" | "beforeFailed" | "all"; isGlobalProfile: boolean; name: string; rules: object[]; ruleStatus?: "pass" | "fail"; }	-
body.applicableBuilds?	{ allBuilds?: boolean; buildNames?: string[]; buildTags?: string[]; }	-
body.applicableBuilds.allBuilds?	boolean	-
body.applicableBuilds.buildNames?	string[]	-
body.applicableBuilds.buildTags?	string[]	-
body.enabled?	boolean	-
body.hooksVisibility?	"failed" | "none" | "beforeFailed" | "all"	-
body.isGlobalProfile?	boolean	-
body.name?	string	-
body.rules?	object[]	-
body.ruleStatus?	"pass" | "fail"	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<{ success?: boolean; uuid?: string; }>

Inherited from

GeneratedTestReportingClient.createQualityGateProfile

---

deleteQualityGateProfile()

deleteQualityGateProfile(projectName, profileUuid, options?): Promise<{ message?: string; }>

Defined in: openapi/generated/test-reporting.client.ts:479

Delete Quality Gate Profile

Parameters

Parameter	Type	Description
projectName	string	-
profileUuid	string	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<{ message?: string; }>

Inherited from

GeneratedTestReportingClient.deleteQualityGateProfile

---

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

GeneratedTestReportingClient.execute

---

finishBuild()

finishBuild(buildHashedId, body, options?): Promise<{ message?: string; success?: boolean; }>

Defined in: openapi/generated/test-reporting.client.ts:185

Finish Build (ingestion)

Parameters

Parameter	Type	Description
buildHashedId	string	-
body	{ finishedAt: string; }	-
body.finishedAt	string	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

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

Inherited from

GeneratedTestReportingClient.finishBuild

---

finishHookRun()

finishHookRun(buildHashedId, hookRunUuid, body, options?): Promise<{ message?: string; success?: boolean; }>

Defined in: openapi/generated/test-reporting.client.ts:269

Finish Hook Run (ingestion)

Parameters

Parameter	Type	Description
buildHashedId	string	-
hookRunUuid	string	-
body	{ customMetadata?: {[key: string]: unknown; }; durationInMs?: number; environment?: {[key: string]: unknown; }; failure?: object[]; fileName: string; finishedAt: string; hookType: string; result: "timeout" | "failed" | "passed" | "skipped"; scopes: string[]; }	-
body.customMetadata?	{[key: string]: unknown; }	-
body.durationInMs?	number	-
body.environment?	{[key: string]: unknown; }	-
body.failure?	object[]	-
body.fileName?	string	-
body.finishedAt?	string	-
body.hookType?	string	-
body.result?	"timeout" | "failed" | "passed" | "skipped"	-
body.scopes?	string[]	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

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

Inherited from

GeneratedTestReportingClient.finishHookRun

---

finishTestRun()

finishTestRun(buildHashedId, testRunUuid, body, options?): Promise<{ message?: string; success?: boolean; }>

Defined in: openapi/generated/test-reporting.client.ts:227

Finish Test Run (ingestion)

Parameters

Parameter	Type	Description
buildHashedId	string	-
testRunUuid	string	-
body	{ customMetadata?: {[key: string]: unknown; }; durationInMs?: number; environment?: {[key: string]: unknown; }; failure?: object[]; fileName: string; finishedAt: string; result: "timeout" | "failed" | "passed" | "skipped"; scopes: string[]; }	-
body.customMetadata?	{[key: string]: unknown; }	-
body.durationInMs?	number	-
body.environment?	{[key: string]: unknown; }	-
body.failure?	object[]	-
body.fileName?	string	-
body.finishedAt?	string	-
body.result?	"timeout" | "failed" | "passed" | "skipped"	-
body.scopes?	string[]	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

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

Inherited from

GeneratedTestReportingClient.finishTestRun

---

getBuild()

getBuild(buildId, options?): Promise<{ buildId?: string; buildNumber?: number; ciInfo?: { buildNumber?: string; buildUrl?: string; jobName?: string; name?: string; }; description?: string; duration?: number; failureCategories?: {[key: string]: number; }; finishedAt?: string; hostInfo?: { hostname?: string; os?: string; }; isArchived?: boolean; name?: string; observabilityUrl?: string; originalName?: string; smartTags?: { isAlwaysFailing?: number; isFlaky?: number; isNewFailure?: number; isPerformanceAnomaly?: number; }; startedAt?: string; status?: string; statusStats?: { failed?: number; passed?: number; pending?: number; skipped?: number; unknown?: number; }; tags?: string[]; user?: string; vcsInfo?: { branch?: string; name?: string; sha?: string; }; }>

Defined in: openapi/generated/test-reporting.client.ts:143

Get Build Details

Parameters

Parameter	Type	Description
buildId	string	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<{ buildId?: string; buildNumber?: number; ciInfo?: { buildNumber?: string; buildUrl?: string; jobName?: string; name?: string; }; description?: string; duration?: number; failureCategories?: {[key: string]: number; }; finishedAt?: string; hostInfo?: { hostname?: string; os?: string; }; isArchived?: boolean; name?: string; observabilityUrl?: string; originalName?: string; smartTags?: { isAlwaysFailing?: number; isFlaky?: number; isNewFailure?: number; isPerformanceAnomaly?: number; }; startedAt?: string; status?: string; statusStats?: { failed?: number; passed?: number; pending?: number; skipped?: number; unknown?: number; }; tags?: string[]; user?: string; vcsInfo?: { branch?: string; name?: string; sha?: string; }; }>

Inherited from

GeneratedTestReportingClient.getBuild

---

getLatestBuild()

getLatestBuild(projectName?, buildName?, userName?, buildTags?, framework?, options?): Promise<{ buildId?: string; buildNumber?: number; ciInfo?: { buildNumber?: string; buildUrl?: string; jobName?: string; name?: string; }; description?: string; duration?: number; failureCategories?: {[key: string]: number; }; finishedAt?: string; hostInfo?: { hostname?: string; os?: string; }; isArchived?: boolean; name?: string; observabilityUrl?: string; originalName?: string; smartTags?: { isAlwaysFailing?: number; isFlaky?: number; isNewFailure?: number; isPerformanceAnomaly?: number; }; startedAt?: string; status?: string; statusStats?: { failed?: number; passed?: number; pending?: number; skipped?: number; unknown?: number; }; tags?: string[]; user?: string; vcsInfo?: { branch?: string; name?: string; sha?: string; }; }>

Defined in: openapi/generated/test-reporting.client.ts:122

Get Latest Build

Parameters

Parameter	Type	Description
projectName?	string	-
buildName?	string	-
userName?	string	-
buildTags?	string	-
framework?	string	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<{ buildId?: string; buildNumber?: number; ciInfo?: { buildNumber?: string; buildUrl?: string; jobName?: string; name?: string; }; description?: string; duration?: number; failureCategories?: {[key: string]: number; }; finishedAt?: string; hostInfo?: { hostname?: string; os?: string; }; isArchived?: boolean; name?: string; observabilityUrl?: string; originalName?: string; smartTags?: { isAlwaysFailing?: number; isFlaky?: number; isNewFailure?: number; isPerformanceAnomaly?: number; }; startedAt?: string; status?: string; statusStats?: { failed?: number; passed?: number; pending?: number; skipped?: number; unknown?: number; }; tags?: string[]; user?: string; vcsInfo?: { branch?: string; name?: string; sha?: string; }; }>

Inherited from

GeneratedTestReportingClient.getLatestBuild

---

getProjectBuilds()

getProjectBuilds(projectId, uniqueBuildNames?, buildTags?, buildStatus?, users?, frameworks?, isArchived?, dateRange?, nextPage?, options?): Promise<{ builds?: object[]; pagination?: { hasNext?: boolean; nextPage?: string; }; }>

Defined in: openapi/generated/test-reporting.client.ts:80

Get Build List for Project

Parameters

Parameter	Type	Description
projectId	number	-
uniqueBuildNames?	string	-
buildTags?	string	-
buildStatus?	string	-
users?	string	-
frameworks?	string	-
isArchived?	string	-
dateRange?	string	-
nextPage?	string	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<{ builds?: object[]; pagination?: { hasNext?: boolean; nextPage?: string; }; }>

Inherited from

GeneratedTestReportingClient.getProjectBuilds

---

getProjects()

getProjects(nextPage?, options?): Promise<{ pagination?: { hasNext?: boolean; nextPage?: string; }; projects?: object[]; }>

Defined in: openapi/generated/test-reporting.client.ts:59

Get Project List

Parameters

Parameter	Type	Description
nextPage?	string	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<{ pagination?: { hasNext?: boolean; nextPage?: string; }; projects?: object[]; }>

Inherited from

GeneratedTestReportingClient.getProjects

---

getQualityGateProfile()

getQualityGateProfile(projectName, profileUuid, options?): Promise<{ applicableBuilds?: {[key: string]: unknown; }; enabled?: boolean; hooksVisibility?: string; id?: string; isGlobalProfile?: boolean; name?: string; rules?: object[]; ruleStatus?: string; }>

Defined in: openapi/generated/test-reporting.client.ts:437

Get Quality Gate Profile

Parameters

Parameter	Type	Description
projectName	string	-
profileUuid	string	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<{ applicableBuilds?: {[key: string]: unknown; }; enabled?: boolean; hooksVisibility?: string; id?: string; isGlobalProfile?: boolean; name?: string; rules?: object[]; ruleStatus?: string; }>

Inherited from

GeneratedTestReportingClient.getQualityGateProfile

---

getQualityGateSettings()

getQualityGateSettings(projectName, options?): Promise<{ enabled?: boolean; qualityProfiles?: object[]; shouldOverrideBuildStatus?: boolean; }>

Defined in: openapi/generated/test-reporting.client.ts:374

Get Quality Gate Settings

Parameters

Parameter	Type	Description
projectName	string	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<{ enabled?: boolean; qualityProfiles?: object[]; shouldOverrideBuildStatus?: boolean; }>

Inherited from

GeneratedTestReportingClient.getQualityGateSettings

---

getQualityGateStatus()

getQualityGateStatus(buildUuid, options?): Promise<{ buildUrl?: string; buildUuid?: string; qualityGateResult?: "unknown" | "running" | "failed" | "passed" | "skipped"; qualityProfiles?: object[]; status?: string; }>

Defined in: openapi/generated/test-reporting.client.ts:353

Get Quality Gate Status

Parameters

Parameter	Type	Description
buildUuid	string	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<{ buildUrl?: string; buildUuid?: string; qualityGateResult?: "unknown" | "running" | "failed" | "passed" | "skipped"; qualityProfiles?: object[]; status?: string; }>

Inherited from

GeneratedTestReportingClient.getQualityGateStatus

---

getSelfHealingReport()

getSelfHealingReport(buildUuid, options?): Promise<{ expiresAt?: string; presignedUrl?: string; }>

Defined in: openapi/generated/test-reporting.client.ts:332

Get Self-Healing Report

Parameters

Parameter	Type	Description
buildUuid	string	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<{ expiresAt?: string; presignedUrl?: string; }>

Inherited from

GeneratedTestReportingClient.getSelfHealingReport

---

getTestRuns()

getTestRuns(buildId, reRuns?, testStatuses?, isFlaky?, isNewFailure?, sort?, order?, nextPage?, options?): Promise<{ buildId?: string; buildName?: string; buildNumber?: number; hierarchy?: object[]; isArchived?: boolean; name?: string; pagination?: { hasNext?: boolean; nextPage?: string; }; projectId?: number; testSummary?: { failed?: number; passed?: number; pending?: number; skipped?: number; unknown?: number; }; }>

Defined in: openapi/generated/test-reporting.client.ts:311

Get Test List

Parameters

Parameter	Type	Description
buildId	string	-
reRuns?	string	-
testStatuses?	string	-
isFlaky?	string	-
isNewFailure?	string	-
sort?	string	-
order?	string	-
nextPage?	string	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<{ buildId?: string; buildName?: string; buildNumber?: number; hierarchy?: object[]; isArchived?: boolean; name?: string; pagination?: { hasNext?: boolean; nextPage?: string; }; projectId?: number; testSummary?: { failed?: number; passed?: number; pending?: number; skipped?: number; unknown?: number; }; }>

Inherited from

GeneratedTestReportingClient.getTestRuns

---

startBuild()

startBuild(body, options?): Promise<{ buildHashedId?: string; success?: boolean; }>

Defined in: openapi/generated/test-reporting.client.ts:101

Start Build (ingestion)

Parameters

Parameter	Type	Description
body	{ buildRunIdentifier?: string; ciInfo?: { buildNumber?: string; buildUrl?: string; jobName?: string; name?: string; url?: string; }; framework: { name: string; version: string; }; hostInfo?: { arch?: string; hostname?: string; platform?: string; type?: string; version?: string; }; name: string; projectName: string; startedAt: string; tags?: string[]; versionControl?: {[key: string]: unknown; }; }	-
body.buildRunIdentifier?	string	-
body.ciInfo?	{ buildNumber?: string; buildUrl?: string; jobName?: string; name?: string; url?: string; }	-
body.ciInfo.buildNumber?	string	-
body.ciInfo.buildUrl?	string	-
body.ciInfo.jobName?	string	-
body.ciInfo.name?	string	-
body.ciInfo.url?	string	-
body.framework?	{ name: string; version: string; }	-
body.framework.name?	string	-
body.framework.version?	string	-
body.hostInfo?	{ arch?: string; hostname?: string; platform?: string; type?: string; version?: string; }	-
body.hostInfo.arch?	string	-
body.hostInfo.hostname?	string	-
body.hostInfo.platform?	string	-
body.hostInfo.type?	string	-
body.hostInfo.version?	string	-
body.name?	string	-
body.projectName?	string	-
body.startedAt?	string	-
body.tags?	string[]	-
body.versionControl?	{[key: string]: unknown; }	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<{ buildHashedId?: string; success?: boolean; }>

Inherited from

GeneratedTestReportingClient.startBuild

---

startHookRun()

startHookRun(buildHashedId, body, options?): Promise<{ success?: boolean; uuid?: string; }>

Defined in: openapi/generated/test-reporting.client.ts:248

Start Hook Run (ingestion)

Parameters

Parameter	Type	Description
buildHashedId	string	-
body	{ customMetadata?: {[key: string]: unknown; }; fileName: string; hookType: string; location?: string; name: string; scopes: string[]; startedAt: string; tags?: string[]; testRunId?: string; }	-
body.customMetadata?	{[key: string]: unknown; }	-
body.fileName?	string	-
body.hookType?	string	-
body.location?	string	-
body.name?	string	-
body.scopes?	string[]	-
body.startedAt?	string	-
body.tags?	string[]	-
body.testRunId?	string	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<{ success?: boolean; uuid?: string; }>

Inherited from

GeneratedTestReportingClient.startHookRun

---

startTestRun()

startTestRun(buildHashedId, body, options?): Promise<{ success?: boolean; uuid?: string; }>

Defined in: openapi/generated/test-reporting.client.ts:206

Start Test Run (ingestion)

Parameters

Parameter	Type	Description
buildHashedId	string	-
body	{ customMetadata?: {[key: string]: unknown; }; environment?: {[key: string]: unknown; }; fileName: string; location?: string; name: string; result?: string; scopes: string[]; startedAt: string; tags?: string[]; }	-
body.customMetadata?	{[key: string]: unknown; }	-
body.environment?	{[key: string]: unknown; }	-
body.fileName?	string	-
body.location?	string	-
body.name?	string	-
body.result?	string	-
body.scopes?	string[]	-
body.startedAt?	string	-
body.tags?	string[]	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<{ success?: boolean; uuid?: string; }>

Inherited from

GeneratedTestReportingClient.startTestRun

---

toggleQualityGateProfile()

toggleQualityGateProfile(projectName, profileUuid, body, options?): Promise<{ message?: string; }>

Defined in: openapi/generated/test-reporting.client.ts:500

Toggle Quality Gate Profile

Parameters

Parameter	Type	Description
projectName	string	-
profileUuid	string	-
body	{ enabled: boolean; }	-
body.enabled	boolean	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<{ message?: string; }>

Inherited from

GeneratedTestReportingClient.toggleQualityGateProfile

---

updateBuild()

updateBuild(buildId, body, options?): Promise<{ message?: string; success?: boolean; }>

Defined in: openapi/generated/test-reporting.client.ts:164

Update Build Metadata

Parameters

Parameter	Type	Description
buildId	string	-
body	{ buildTags?: string[]; }	-
body.buildTags?	string[]	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

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

Inherited from

GeneratedTestReportingClient.updateBuild

---

updateQualityGateProfile()

updateQualityGateProfile(projectName, profileUuid, body, options?): Promise<{ success?: boolean; uuid?: string; }>

Defined in: openapi/generated/test-reporting.client.ts:458

Update Quality Gate Profile

Parameters

Parameter	Type	Description
projectName	string	-
profileUuid	string	-
body	{ applicableBuilds?: { allBuilds?: boolean; buildNames?: string[]; buildTags?: string[]; }; enabled: boolean; hooksVisibility?: "failed" | "none" | "beforeFailed" | "all"; isGlobalProfile: boolean; name: string; rules: object[]; ruleStatus?: "pass" | "fail"; }	-
body.applicableBuilds?	{ allBuilds?: boolean; buildNames?: string[]; buildTags?: string[]; }	-
body.applicableBuilds.allBuilds?	boolean	-
body.applicableBuilds.buildNames?	string[]	-
body.applicableBuilds.buildTags?	string[]	-
body.enabled?	boolean	-
body.hooksVisibility?	"failed" | "none" | "beforeFailed" | "all"	-
body.isGlobalProfile?	boolean	-
body.name?	string	-
body.rules?	object[]	-
body.ruleStatus?	"pass" | "fail"	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<{ success?: boolean; uuid?: string; }>

Inherited from

GeneratedTestReportingClient.updateQualityGateProfile

---

updateQualityGateSettings()

updateQualityGateSettings(projectName, body, options?): Promise<{ message?: string; }>

Defined in: openapi/generated/test-reporting.client.ts:395

Update Quality Gate Settings

Parameters

Parameter	Type	Description
projectName	string	-
body	{ enabled: boolean; }	-
body.enabled	boolean	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<{ message?: string; }>

Inherited from

GeneratedTestReportingClient.updateQualityGateSettings

---

uploadReport()

uploadReport(body, options?): Promise<{ message?: string; status?: string; }>

Defined in: openapi/generated/test-reporting.client.ts:521

Upload Test Reports (JUnit or Allure)

Parameters

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

Returns

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

Inherited from

GeneratedTestReportingClient.uploadReport