Documentation / test-reporting / TestReportingClient

Class: TestReportingClient

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

Extends

• GeneratedTestReportingClient

Constructors

Constructor

new TestReportingClient(options?): TestReportingClient

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

Parameters

Parameter	Type
options?	TestReportingClientOptions

Returns

TestReportingClient

Overrides

GeneratedTestReportingClient.constructor

Properties

Property	Type	Default value	Description	Inherited from	Defined in
authHeader?	string	undefined	HTTP Basic Auth header derived from username and access key.	GeneratedTestReportingClient.authHeader	core/src/api-client.ts:55
baseUrls	object	undefined	Base URLs used for API requests.	GeneratedTestReportingClient.baseUrls	core/src/api-client.ts:53
baseUrls.sdk	string	undefined	-	-	core/src/api-client.ts:53
baseUrls.sdkCloud	string	undefined	-	-	core/src/api-client.ts:53
clientTimeout?	number	undefined	-	GeneratedTestReportingClient.clientTimeout	core/src/api-client.ts:66
fetchFn	{(input, init?): Promise<Response>; (input, init?): Promise<Response>; }	undefined	Fetch implementation used to make HTTP requests.	GeneratedTestReportingClient.fetchFn	core/src/api-client.ts:59
registry	CodecRegistry	undefined	Registry of request and response codecs.	GeneratedTestReportingClient.registry	core/src/api-client.ts:61
userAgent	string	undefined	User-Agent string sent with every request.	GeneratedTestReportingClient.userAgent	core/src/api-client.ts:57
extractSessionId	(node) => string | undefined	extractSessionId	The session id of a test node, or undefined when it ran without a session.	-	test-reporting/src/index.ts:85

Methods

addBuildLogs()

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

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

Add Build Logs (ingestion)

Parameters

Parameter	Type
buildHashedId	string
body	{ logs: object[]; }
body.logs	object[]

Returns

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

Overrides

GeneratedTestReportingClient.addBuildLogs

---

addTestScreenshots()

addTestScreenshots(buildHashedId, screenshots): Promise<void>

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

Attaches screenshots to test runs: kind TEST_SCREENSHOT logs whose message is the base64 image.

Parameters

Parameter	Type
buildHashedId	string
screenshots	object[]

Returns

Promise<void>

---

createQualityGateProfile()

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

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

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:491

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): Promise<{ message?: string; success?: boolean; }>

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

Finish Build (ingestion)

Parameters

Parameter	Type	Description
buildHashedId	string	-
body	{ finishedAt: string; }	-
body.finishedAt	string	Format: date-time

Returns

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

Overrides

GeneratedTestReportingClient.finishBuild

---

finishHookRun()

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

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

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	Format: date-time
body.hookType	string	-
body.result	"timeout" | "failed" | "passed" | "skipped"	-
body.scopes	string[]	-

Returns

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

Overrides

GeneratedTestReportingClient.finishHookRun

---

finishTestRun()

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

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

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	Format: date-time
body.result	"timeout" | "failed" | "passed" | "skipped"	-
body.scopes	string[]	-

Returns

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

Overrides

GeneratedTestReportingClient.finishTestRun

---

getBuild()

getBuild(buildId, options?): Promise<{ appDetails?: {[key: string]: unknown; } | null; buildError?: {[key: string]: unknown; } | null; buildId?: string; buildNumber?: number; ciInfo?: { buildNumber?: string | null; buildUrl?: string | null; jobName?: string | null; name?: string | null; url?: string | null; }; createdAt?: string | null; description?: string; duration?: number; failureCategories?: {[key: string]: number; }; finishedAt?: string | null; hostInfo?: { hostname?: string | null; os?: string | null; }; id?: number; isArchived?: boolean; isManuallyOverridden?: boolean; name?: string; observabilityUrl?: string; observabilityVersion?: { cliVersion?: string; frameworkName?: string; frameworkVersion?: string; isSdk?: string; outdatedCliVersion?: string; outdatedSdkVersion?: string; sdkVersion?: string; }; originalName?: string; projectId?: number | null; projectName?: string | null; reRun?: {[key: string]: unknown; } | null; runInformation?: object[]; smartTags?: { isAlwaysFailing?: number; isFlaky?: number; isNewFailure?: number; isPerformanceAnomaly?: number; }; startedAt?: string; status?: string; statusStats?: { blocked?: number; failed?: number; in progress?: number; passed?: number; pending?: number; retest?: number; skipped?: number; timeout?: number; unknown?: number; untested?: number; }; tags?: string[]; tcmTestRunIdentifier?: string; user?: string; userId?: number; vcsInfo?: { branch?: string | null; name?: string | null; remotes?: {[key: string]: unknown; } | null; sha?: string | null; url?: string | null; }; }>

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

Get Build Details

Parameters

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

Returns

Promise<{ appDetails?: {[key: string]: unknown; } | null; buildError?: {[key: string]: unknown; } | null; buildId?: string; buildNumber?: number; ciInfo?: { buildNumber?: string | null; buildUrl?: string | null; jobName?: string | null; name?: string | null; url?: string | null; }; createdAt?: string | null; description?: string; duration?: number; failureCategories?: {[key: string]: number; }; finishedAt?: string | null; hostInfo?: { hostname?: string | null; os?: string | null; }; id?: number; isArchived?: boolean; isManuallyOverridden?: boolean; name?: string; observabilityUrl?: string; observabilityVersion?: { cliVersion?: string; frameworkName?: string; frameworkVersion?: string; isSdk?: string; outdatedCliVersion?: string; outdatedSdkVersion?: string; sdkVersion?: string; }; originalName?: string; projectId?: number | null; projectName?: string | null; reRun?: {[key: string]: unknown; } | null; runInformation?: object[]; smartTags?: { isAlwaysFailing?: number; isFlaky?: number; isNewFailure?: number; isPerformanceAnomaly?: number; }; startedAt?: string; status?: string; statusStats?: { blocked?: number; failed?: number; in progress?: number; passed?: number; pending?: number; retest?: number; skipped?: number; timeout?: number; unknown?: number; untested?: number; }; tags?: string[]; tcmTestRunIdentifier?: string; user?: string; userId?: number; vcsInfo?: { branch?: string | null; name?: string | null; remotes?: {[key: string]: unknown; } | null; sha?: string | null; url?: string | null; }; }>

Inherited from

GeneratedTestReportingClient.getBuild

---

getBuildTests()

getBuildTests(buildId): Promise<BuildTest[]>

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

Every TEST/HOOK of a build, following pagination, flattened from the ROOT → DESCRIBE → TEST tree. Each carries sessionId, the hashed_id of its Automate (web) or App Automate (mobile) session.

Parameters

Parameter	Type
buildId	string

Returns

Promise<BuildTest[]>

---

getBuildTestSessions()

getBuildTestSessions(buildId): Promise<BuildTestSession[]>

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

The build's tests grouped by session, in first-seen order. Sessions are per worker/file. Tests without a session are omitted.

Parameters

Parameter	Type
buildId	string

Returns

Promise<BuildTestSession[]>

---

getLatestBuild()

getLatestBuild(projectName?, buildName?, userName?, buildTags?, framework?, options?): Promise<{ appDetails?: {[key: string]: unknown; } | null; buildError?: {[key: string]: unknown; } | null; buildId?: string; buildNumber?: number; ciInfo?: { buildNumber?: string | null; buildUrl?: string | null; jobName?: string | null; name?: string | null; url?: string | null; }; createdAt?: string | null; description?: string; duration?: number; failureCategories?: {[key: string]: number; }; finishedAt?: string | null; hostInfo?: { hostname?: string | null; os?: string | null; }; id?: number; isArchived?: boolean; isManuallyOverridden?: boolean; name?: string; observabilityUrl?: string; observabilityVersion?: { cliVersion?: string; frameworkName?: string; frameworkVersion?: string; isSdk?: string; outdatedCliVersion?: string; outdatedSdkVersion?: string; sdkVersion?: string; }; originalName?: string; projectId?: number | null; projectName?: string | null; reRun?: {[key: string]: unknown; } | null; runInformation?: object[]; smartTags?: { isAlwaysFailing?: number; isFlaky?: number; isNewFailure?: number; isPerformanceAnomaly?: number; }; startedAt?: string; status?: string; statusStats?: { blocked?: number; failed?: number; in progress?: number; passed?: number; pending?: number; retest?: number; skipped?: number; timeout?: number; unknown?: number; untested?: number; }; tags?: string[]; tcmTestRunIdentifier?: string; user?: string; userId?: number; vcsInfo?: { branch?: string | null; name?: string | null; remotes?: {[key: string]: unknown; } | null; sha?: string | null; url?: string | null; }; }>

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

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<{ appDetails?: {[key: string]: unknown; } | null; buildError?: {[key: string]: unknown; } | null; buildId?: string; buildNumber?: number; ciInfo?: { buildNumber?: string | null; buildUrl?: string | null; jobName?: string | null; name?: string | null; url?: string | null; }; createdAt?: string | null; description?: string; duration?: number; failureCategories?: {[key: string]: number; }; finishedAt?: string | null; hostInfo?: { hostname?: string | null; os?: string | null; }; id?: number; isArchived?: boolean; isManuallyOverridden?: boolean; name?: string; observabilityUrl?: string; observabilityVersion?: { cliVersion?: string; frameworkName?: string; frameworkVersion?: string; isSdk?: string; outdatedCliVersion?: string; outdatedSdkVersion?: string; sdkVersion?: string; }; originalName?: string; projectId?: number | null; projectName?: string | null; reRun?: {[key: string]: unknown; } | null; runInformation?: object[]; smartTags?: { isAlwaysFailing?: number; isFlaky?: number; isNewFailure?: number; isPerformanceAnomaly?: number; }; startedAt?: string; status?: string; statusStats?: { blocked?: number; failed?: number; in progress?: number; passed?: number; pending?: number; retest?: number; skipped?: number; timeout?: number; unknown?: number; untested?: number; }; tags?: string[]; tcmTestRunIdentifier?: string; user?: string; userId?: number; vcsInfo?: { branch?: string | null; name?: string | null; remotes?: {[key: string]: unknown; } | null; sha?: string | null; url?: string | null; }; }>

Inherited from

GeneratedTestReportingClient.getLatestBuild

---

getProjectBuilds()

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

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

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	Start and end as epoch milliseconds, comma-separated: startMs,endMs. Anything else is rejected with a 400. Verified against the live API.
nextPage?	string	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<{ builds?: object[]; id?: number; name?: string; pagination?: { hasNext?: boolean; nextPage?: string | null; }; }>

Inherited from

GeneratedTestReportingClient.getProjectBuilds

---

getProjects()

getProjects(nextPage?, options?): Promise<{ pagination?: { hasNext?: boolean; nextPage?: string | null; }; 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 | null; }; 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:449

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:386

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:365

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:344

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?, ciBuildNumbers?, hostNames?, hasPerformanceAnomaly?, isAlwaysFailing?, isMuted?, failureCategories?, devices?, os?, options?): Promise<{ appDetails?: {[key: string]: unknown; } | null; buildId?: string; buildName?: string; buildNumber?: number; groupId?: number; hierarchy?: object[]; isArchived?: boolean; isManuallyOverridden?: boolean; name?: string; originalName?: string; pagination?: { hasNext?: boolean; nextPage?: string | null; }; projectId?: number; testSummary?: { blocked?: number; failed?: number; in progress?: number; passed?: number; pending?: number; retest?: number; skipped?: number; timeout?: number; unknown?: number; untested?: number; }; }>

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

Get Test List

Parameters

Parameter	Type	Description
buildId	string	-
reRuns?	string	Comma-separated re-run numbers (integers). Returns only tests from those re-runs, so it is empty for a build without re-runs. Verified against the live API.
testStatuses?	string	-
isFlaky?	string	Smart-tag filter. Needs a plan with smart tags; otherwise the API answers 4xx with: Smart tag filters cannot be used due to plan restrictions on your group.
isNewFailure?	string	Smart-tag filter. Needs a plan with smart tags; otherwise the API answers 4xx with: Smart tag filters cannot be used due to plan restrictions on your group.
sort?	string	-
order?	string	-
nextPage?	string	-
ciBuildNumbers?	string	Comma-separated CI build numbers. Verified against the live API.
hostNames?	string	Comma-separated host names. Verified against the live API.
hasPerformanceAnomaly?	string	Smart-tag filter. Needs a plan with smart tags; otherwise the API answers 4xx with: Smart tag filters cannot be used due to plan restrictions on your group.
isAlwaysFailing?	string	Smart-tag filter. Needs a plan with smart tags; otherwise the API answers 4xx with: Smart tag filters cannot be used due to plan restrictions on your group.
isMuted?	string	Verified against the live API.
failureCategories?	string	Comma-separated failure categories. Verified against the live API.
devices?	string	Comma-separated devices. Verified against the live API.
os?	string	Comma-separated operating systems. Verified against the live API.
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<{ appDetails?: {[key: string]: unknown; } | null; buildId?: string; buildName?: string; buildNumber?: number; groupId?: number; hierarchy?: object[]; isArchived?: boolean; isManuallyOverridden?: boolean; name?: string; originalName?: string; pagination?: { hasNext?: boolean; nextPage?: string | null; }; projectId?: number; testSummary?: { blocked?: number; failed?: number; in progress?: number; passed?: number; pending?: number; retest?: number; skipped?: number; timeout?: number; unknown?: number; untested?: number; }; }>

Inherited from

GeneratedTestReportingClient.getTestRuns

---

getTestSession()

getTestSession(sessionId, hint?): Promise<LinkedSession | undefined>

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

The Automate or App Automate session behind a test's session id, or undefined when neither knows it. Pass hint.device for tests TRA reports a device for, to ask App Automate first. Cached per client.

Parameters

Parameter	Type
sessionId	string
hint?	SessionHint

Returns

Promise<LinkedSession | undefined>

---

getTestSessionLogs()

getTestSessionLogs(sessionId, kinds?, hint?): Promise<SessionLogs>

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

Fetches a test session's logs from whichever product owns it. Without kinds, fetches the text log plus every kind the session reports a URL for. A log that doesn't exist (or, on App Automate, was never captured) comes back as { status: "missing" } rather than throwing, and so does a kind the owning product doesn't have. An unknown session yields {}. Tests in one file share a session, so logs are not split per test.

Parameters

Parameter	Type
sessionId	string
kinds?	LogKind[]
hint?	SessionHint

Returns

Promise<SessionLogs>

---

linkTestRunSession()

linkTestRunSession(buildHashedId, testRunUuid, session): Promise<void>

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

Links a test run to the BrowserStack session it ran in, so TRA can show its session, logs and video (what WebdriverIO sends as a CBTSessionCreated event). Takes the uuid startTestRun returned.

Parameters

Parameter	Type
buildHashedId	string
testRunUuid	string
session	RunSession

Returns

Promise<void>

---

startBuild()

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

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

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	Format: date-time
body.tags?	string[]	-
body.versionControl?	{[key: string]: unknown; }	-

Returns

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

Overrides

GeneratedTestReportingClient.startBuild

---

startHookRun()

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

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

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	Format: date-time
body.tags?	string[]	-
body.testRunId?	string	-

Returns

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

Overrides

GeneratedTestReportingClient.startHookRun

---

startTestRun()

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

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

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	Format: date-time
body.tags?	string[]	-

Returns

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

Overrides

GeneratedTestReportingClient.startTestRun

---

toggleQualityGateProfile()

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

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

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:165

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:470

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:407

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:533

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