Documentation / accessibility / AccessibilityClient

Class: AccessibilityClient

Defined in: accessibility/src/index.ts:4

Extends

• GeneratedAccessibilityClient

Constructors

Constructor

new AccessibilityClient(options?): AccessibilityClient

Defined in: accessibility/src/index.ts:5

Parameters

Parameter	Type
options?	BrowserStackOptions

Returns

AccessibilityClient

Overrides

GeneratedAccessibilityClient.constructor

Properties

Property	Modifier	Type	Inherited from	Defined in
authHeader?	readonly	string	GeneratedAccessibilityClient.authHeader	core/src/api-client.ts:50
baseUrls	readonly	object	GeneratedAccessibilityClient.baseUrls	core/src/api-client.ts:49
baseUrls.sdk	public	string	-	core/src/api-client.ts:49
baseUrls.sdkCloud	public	string	-	core/src/api-client.ts:49
fetchFn	readonly	(input, init?) => Promise<Response>	GeneratedAccessibilityClient.fetchFn	core/src/api-client.ts:52
registry	readonly	CodecRegistry	GeneratedAccessibilityClient.registry	core/src/api-client.ts:53
userAgent	readonly	string	GeneratedAccessibilityClient.userAgent	core/src/api-client.ts:51

Methods

createWebsiteScannerAuthConfig()

createWebsiteScannerAuthConfig(body, options?): Promise<CreateAccessibilityWebsiteScannerAuthConfigResult>

Defined in: openapi/generated/accessibility.client.ts:193

Creates a new authentication configuration for the Website Scanner to access login-protected pages during scans.

Parameters

Parameter	Type
body	{ authData?: { password?: string; passwordSelector?: string; submitSelector?: string; url?: string; username?: string; usernameSelector?: string; }; name?: string; type?: string; }
body.authData?	{ password?: string; passwordSelector?: string; submitSelector?: string; url?: string; username?: string; usernameSelector?: string; }
body.authData.password?	string
body.authData.passwordSelector?	string
body.authData.submitSelector?	string
body.authData.url?	string
body.authData.username?	string
body.authData.usernameSelector?	string
body.name?	string
body.type?	string
options?	ExecuteOptions

Returns

Promise<CreateAccessibilityWebsiteScannerAuthConfigResult>

Inherited from

GeneratedAccessibilityClient.createWebsiteScannerAuthConfig

---

createWebsiteScannerScan()

createWebsiteScannerScan(body, options?): Promise<CreateAccessibilityWebsiteScannerScanResult>

Defined in: openapi/generated/accessibility.client.ts:227

Creates and triggers a new Website Scanner accessibility scan for the specified URL.

Parameters

Parameter	Type
body	{ scanUrl?: string; }
body.scanUrl?	string
options?	ExecuteOptions

Returns

Promise<CreateAccessibilityWebsiteScannerScanResult>

Inherited from

GeneratedAccessibilityClient.createWebsiteScannerScan

---

execute()

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

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

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

GeneratedAccessibilityClient.execute

---

getAssistedTestReportIssues()

getAssistedTestReportIssues(reportId?, taskId?, nextPage?, options?): Promise<{ advanced?: boolean; assistedTestType?: string; bestPractices?: boolean; engineInfo?: { name?: string; version?: string; }; id?: number; name?: string; needsReview?: boolean; pagination?: { hasNext?: boolean; nextPage?: string; }; reportLink?: string; scanType?: string; status?: string; time?: string; wcagVersion?: string; }>

Defined in: openapi/generated/accessibility.client.ts:159

Returns the paginated list of accessibility issues for a specific Assisted Test report, optionally filtered by task.

Parameters

Parameter	Type
reportId?	number
taskId?	string
nextPage?	string
options?	ExecuteOptions

Returns

Promise<{ advanced?: boolean; assistedTestType?: string; bestPractices?: boolean; engineInfo?: { name?: string; version?: string; }; id?: number; name?: string; needsReview?: boolean; pagination?: { hasNext?: boolean; nextPage?: string; }; reportLink?: string; scanType?: string; status?: string; time?: string; wcagVersion?: string; }>

Inherited from

GeneratedAccessibilityClient.getAssistedTestReportIssues

---

getAssistedTestReports()

getAssistedTestReports(options?): Promise<{ pagination?: { hasNext?: boolean; nextPage?: string; }; reports?: object[]; }>

Defined in: openapi/generated/accessibility.client.ts:125

Returns a paginated list of all Assisted Test accessibility reports for your account.

Parameters

Parameter	Type
options?	ExecuteOptions

Returns

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

Inherited from

GeneratedAccessibilityClient.getAssistedTestReports

---

getAssistedTestReportSummary()

getAssistedTestReportSummary(reportId, options?): Promise<{ advanced?: boolean; assistedTestType?: string; bestPractices?: boolean; createdBy?: { name?: string; userId?: number; }; engineInfo?: { name?: string; version?: string; }; id?: number; issueCount?: { issueCountByCategory?: object[]; issueCountByComponent?: object[]; issueCountBySeverity?: { critical?: number; minor?: number; moderate?: number; serious?: number; }; issueCountByURL?: object[]; }; issueSummary?: { componentCount?: number; issueCount?: number; pageCount?: number; }; name?: string; needsReview?: boolean; scanType?: string; scoreData?: { impact?: { critical?: number; minor?: number; moderate?: number; serious?: number; }; score?: number; }; status?: string; time?: string; wcagVersion?: string; }>

Defined in: openapi/generated/accessibility.client.ts:142

Returns the summary for a specific Assisted Test report, including score, issue counts, and scan metadata.

Parameters

Parameter	Type
reportId	number
options?	ExecuteOptions

Returns

Promise<{ advanced?: boolean; assistedTestType?: string; bestPractices?: boolean; createdBy?: { name?: string; userId?: number; }; engineInfo?: { name?: string; version?: string; }; id?: number; issueCount?: { issueCountByCategory?: object[]; issueCountByComponent?: object[]; issueCountBySeverity?: { critical?: number; minor?: number; moderate?: number; serious?: number; }; issueCountByURL?: object[]; }; issueSummary?: { componentCount?: number; issueCount?: number; pageCount?: number; }; name?: string; needsReview?: boolean; scanType?: string; scoreData?: { impact?: { critical?: number; minor?: number; moderate?: number; serious?: number; }; score?: number; }; status?: string; time?: string; wcagVersion?: string; }>

Inherited from

GeneratedAccessibilityClient.getAssistedTestReportSummary

---

getAutomatedTestBuildIssues()

getAutomatedTestBuildIssues(buildId?, taskId?, nextPage?, options?): Promise<{ advanced?: boolean; bestPractice?: boolean; buildNumber?: number; buildUId?: string; needsReview?: boolean; pagination?: { hasNext?: boolean; nextPage?: string; }; reportLink?: string; testEngine?: { name?: string; version?: string; }; time?: string; wcagVersion?: string; }>

Defined in: openapi/generated/accessibility.client.ts:414

Returns paginated accessibility issues for a specific Automated Test build, optionally filtered by task.

Parameters

Parameter	Type
buildId?	string
taskId?	string
nextPage?	string
options?	ExecuteOptions

Returns

Promise<{ advanced?: boolean; bestPractice?: boolean; buildNumber?: number; buildUId?: string; needsReview?: boolean; pagination?: { hasNext?: boolean; nextPage?: string; }; reportLink?: string; testEngine?: { name?: string; version?: string; }; time?: string; wcagVersion?: string; }>

Inherited from

GeneratedAccessibilityClient.getAutomatedTestBuildIssues

---

getAutomatedTestBuilds()

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

Defined in: openapi/generated/accessibility.client.ts:363

Returns a paginated list of Automated Test accessibility builds, optionally filtered by project.

Parameters

Parameter	Type
nextPage?	string
projectId?	number
options?	ExecuteOptions

Returns

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

Inherited from

GeneratedAccessibilityClient.getAutomatedTestBuilds

---

getAutomatedTestBuildSummary()

getAutomatedTestBuildSummary(thBuildId, nextPage?, options?): Promise<GetAccessibilityAutomatedTestBuildSummaryResult>

Defined in: openapi/generated/accessibility.client.ts:397

Returns the summary for a specific Automated Test build, including score, health stats, and issue counts.

Parameters

Parameter	Type
thBuildId	string
nextPage?	string
options?	ExecuteOptions

Returns

Promise<GetAccessibilityAutomatedTestBuildSummaryResult>

Inherited from

GeneratedAccessibilityClient.getAutomatedTestBuildSummary

---

getAutomatedTestBuildTestCaseIssues()

getAutomatedTestBuildTestCaseIssues(thBuildId, testCase?, taskId?, nextPage?, options?): Promise<{ browserData?: { logo?: string; name?: string; version?: string; }; file?: string; name?: string; osData?: { logo?: string; name?: string; version?: string | null; }; pagination?: { hasNext?: boolean; nextPage?: string; }; reportLink?: string; scopeList?: string[]; tags?: string | null; }>

Defined in: openapi/generated/accessibility.client.ts:448

Returns paginated accessibility issues for a specific test case within an Automated Test build.

Parameters

Parameter	Type
thBuildId	string
testCase?	string
taskId?	string
nextPage?	string
options?	ExecuteOptions

Returns

Promise<{ browserData?: { logo?: string; name?: string; version?: string; }; file?: string; name?: string; osData?: { logo?: string; name?: string; version?: string | null; }; pagination?: { hasNext?: boolean; nextPage?: string; }; reportLink?: string; scopeList?: string[]; tags?: string | null; }>

Inherited from

GeneratedAccessibilityClient.getAutomatedTestBuildTestCaseIssues

---

getAutomatedTestBuildTestCases()

getAutomatedTestBuildTestCases(thBuildId, nextPage?, options?): Promise<GetAccessibilityAutomatedTestBuildTestCasesResult>

Defined in: openapi/generated/accessibility.client.ts:380

Returns the paginated list of test cases and their accessibility results for a specific Automated Test build.

Parameters

Parameter	Type
thBuildId	string
nextPage?	string
options?	ExecuteOptions

Returns

Promise<GetAccessibilityAutomatedTestBuildTestCasesResult>

Inherited from

GeneratedAccessibilityClient.getAutomatedTestBuildTestCases

---

getAutomatedTestBuildTestCaseSummary()

getAutomatedTestBuildTestCaseSummary(thBuildId, testCaseId, nextPage?, options?): Promise<GetAccessibilityAutomatedTestBuildTestCaseSummaryResult>

Defined in: openapi/generated/accessibility.client.ts:431

Returns the accessibility summary for a specific test case within an Automated Test build.

Parameters

Parameter	Type
thBuildId	string
testCaseId	string
nextPage?	string
options?	ExecuteOptions

Returns

Promise<GetAccessibilityAutomatedTestBuildTestCaseSummaryResult>

Inherited from

GeneratedAccessibilityClient.getAutomatedTestBuildTestCaseSummary

---

getAutomatedTestProjects()

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

Defined in: openapi/generated/accessibility.client.ts:346

Returns a paginated list of all Automated Test accessibility projects for your account.

Parameters

Parameter	Type
nextPage?	string
options?	ExecuteOptions

Returns

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

Inherited from

GeneratedAccessibilityClient.getAutomatedTestProjects

---

getWebsiteScannerAuthConfigs()

getWebsiteScannerAuthConfigs(options?): Promise<GetAccessibilityWebsiteScannerAuthConfigsResult>

Defined in: openapi/generated/accessibility.client.ts:176

Returns all saved authentication configurations used by the Website Scanner for login-protected pages.

Parameters

Parameter	Type
options?	ExecuteOptions

Returns

Promise<GetAccessibilityWebsiteScannerAuthConfigsResult>

Inherited from

GeneratedAccessibilityClient.getWebsiteScannerAuthConfigs

---

getWebsiteScannerScanOverview()

getWebsiteScannerScanOverview(scanId, options?): Promise<GetAccessibilityWebsiteScannerScanOverviewResult>

Defined in: openapi/generated/accessibility.client.ts:244

Returns the configuration overview for a specific Website Scanner scan, including URL list and scan settings.

Parameters

Parameter	Type
scanId	number
options?	ExecuteOptions

Returns

Promise<GetAccessibilityWebsiteScannerScanOverviewResult>

Inherited from

GeneratedAccessibilityClient.getWebsiteScannerScanOverview

---

getWebsiteScannerScanRunIssues()

getWebsiteScannerScanRunIssues(scanId, scanRunId?, taskId?, nextPage?, options?): Promise<{ advanced?: boolean; bestPractices?: boolean; engineInfo?: { name?: string; version?: string; }; needsReview?: boolean; reportLink?: string; scanId?: number; scanRunId?: number; time?: string; wcagVersion?: string; }>

Defined in: openapi/generated/accessibility.client.ts:312

Returns paginated accessibility issues found during a specific Website Scanner scan run, optionally filtered by task.

Parameters

Parameter	Type
scanId	number
scanRunId?	number
taskId?	string
nextPage?	string
options?	ExecuteOptions

Returns

Promise<{ advanced?: boolean; bestPractices?: boolean; engineInfo?: { name?: string; version?: string; }; needsReview?: boolean; reportLink?: string; scanId?: number; scanRunId?: number; time?: string; wcagVersion?: string; }>

Inherited from

GeneratedAccessibilityClient.getWebsiteScannerScanRunIssues

---

getWebsiteScannerScanRunLogs()

getWebsiteScannerScanRunLogs(scanId, scanRunId, options?): Promise<GetAccessibilityWebsiteScannerScanRunLogsResult>

Defined in: openapi/generated/accessibility.client.ts:329

Returns the crawl logs for a specific Website Scanner scan run, including per-URL status, redirects, and errors.

Parameters

Parameter	Type
scanId	number
scanRunId	number
options?	ExecuteOptions

Returns

Promise<GetAccessibilityWebsiteScannerScanRunLogsResult>

Inherited from

GeneratedAccessibilityClient.getWebsiteScannerScanRunLogs

---

getWebsiteScannerScanRuns()

getWebsiteScannerScanRuns(scanId, page?, pageSize?, options?): Promise<{ pagination?: { hasNext?: boolean; nextPage?: string; }; scanRuns?: object[]; }>

Defined in: openapi/generated/accessibility.client.ts:261

Returns a paginated list of all scan runs for a specific Website Scanner scan, including status and issue counts.

Parameters

Parameter	Type
scanId	number
page?	number
pageSize?	number
options?	ExecuteOptions

Returns

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

Inherited from

GeneratedAccessibilityClient.getWebsiteScannerScanRuns

---

getWebsiteScannerScanRunStatus()

getWebsiteScannerScanRunStatus(scanId, scanRunId, options?): Promise<GetAccessibilityWebsiteScannerScanRunStatusResult>

Defined in: openapi/generated/accessibility.client.ts:295

Returns the current execution status of a specific Website Scanner scan run.

Parameters

Parameter	Type
scanId	number
scanRunId	number
options?	ExecuteOptions

Returns

Promise<GetAccessibilityWebsiteScannerScanRunStatusResult>

Inherited from

GeneratedAccessibilityClient.getWebsiteScannerScanRunStatus

---

getWebsiteScannerScanRunSummary()

getWebsiteScannerScanRunSummary(scanId, scanRunId, options?): Promise<{ advanced?: boolean; authEnabled?: boolean; bestPractices?: boolean; changesSinceLastRun?: { newIssues?: number; resolvedIssues?: number; retainedIssues?: number; }; engineInfo?: { name?: string; version?: string; }; issueCount?: { issueCountByCategory?: object[]; issueCountByComponent?: object[]; issueCountBySeverity?: { critical?: number; minor?: number; moderate?: number; serious?: number; }; issueCountByURL?: object[]; }; issueSummary?: { componentCount?: number; hidden?: number; issueCount?: number; needsReview?: number; pageCount?: number; }; localTestingEnabled?: boolean; needsReview?: boolean; pagination?: { hasNext?: boolean; nextPage?: string; }; scanId?: number; scanRunId?: number; scoreData?: { impact?: { critical?: number; minor?: number; moderate?: number; serious?: number; }; score?: number; }; status?: string; time?: string; wcagVersion?: string; }>

Defined in: openapi/generated/accessibility.client.ts:278

Returns a detailed summary for a specific scan run, including score, issue counts, and changes since the last run.

Parameters

Parameter	Type
scanId	number
scanRunId	number
options?	ExecuteOptions

Returns

Promise<{ advanced?: boolean; authEnabled?: boolean; bestPractices?: boolean; changesSinceLastRun?: { newIssues?: number; resolvedIssues?: number; retainedIssues?: number; }; engineInfo?: { name?: string; version?: string; }; issueCount?: { issueCountByCategory?: object[]; issueCountByComponent?: object[]; issueCountBySeverity?: { critical?: number; minor?: number; moderate?: number; serious?: number; }; issueCountByURL?: object[]; }; issueSummary?: { componentCount?: number; hidden?: number; issueCount?: number; needsReview?: number; pageCount?: number; }; localTestingEnabled?: boolean; needsReview?: boolean; pagination?: { hasNext?: boolean; nextPage?: string; }; scanId?: number; scanRunId?: number; scoreData?: { impact?: { critical?: number; minor?: number; moderate?: number; serious?: number; }; score?: number; }; status?: string; time?: string; wcagVersion?: string; }>

Inherited from

GeneratedAccessibilityClient.getWebsiteScannerScanRunSummary

---

getWebsiteScannerScans()

getWebsiteScannerScans(options?): Promise<{ pagination?: { hasNext?: boolean; nextPage?: string; }; scans?: object[]; }>

Defined in: openapi/generated/accessibility.client.ts:210

Returns a paginated list of all configured Website Scanner scans for your account.

Parameters

Parameter	Type
options?	ExecuteOptions

Returns

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

Inherited from

GeneratedAccessibilityClient.getWebsiteScannerScans

---

getWorkflowAnalyzerReportIssues()

getWorkflowAnalyzerReportIssues(reportId?, taskId?, nextPage?, options?): Promise<{ advanced?: boolean; bestPractices?: boolean; engineInfo?: { name?: string; version?: string; }; id?: number; name?: string; needsReview?: boolean; pagination?: { hasNext?: boolean; nextPage?: string; }; reportLink?: string; scanType?: string; status?: string; time?: string; wcagVersion?: string; }>

Defined in: openapi/generated/accessibility.client.ts:108

Returns the paginated list of accessibility issues for a specific Workflow Analyzer report, optionally filtered by task.

Parameters

Parameter	Type
reportId?	number
taskId?	string
nextPage?	string
options?	ExecuteOptions

Returns

Promise<{ advanced?: boolean; bestPractices?: boolean; engineInfo?: { name?: string; version?: string; }; id?: number; name?: string; needsReview?: boolean; pagination?: { hasNext?: boolean; nextPage?: string; }; reportLink?: string; scanType?: string; status?: string; time?: string; wcagVersion?: string; }>

Inherited from

GeneratedAccessibilityClient.getWorkflowAnalyzerReportIssues

---

getWorkflowAnalyzerReports()

getWorkflowAnalyzerReports(options?): Promise<{ pagination?: { hasNext?: boolean; nextPage?: string; }; reports?: object[]; }>

Defined in: openapi/generated/accessibility.client.ts:74

Returns a paginated list of all Workflow Analyzer accessibility reports for your account.

Parameters

Parameter	Type
options?	ExecuteOptions

Returns

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

Inherited from

GeneratedAccessibilityClient.getWorkflowAnalyzerReports

---

getWorkflowAnalyzerReportSummary()

getWorkflowAnalyzerReportSummary(reportId, options?): Promise<{ advanced?: boolean; bestPractices?: boolean; createdBy?: { name?: string; userId?: number; }; engineInfo?: { name?: string; version?: string; }; id?: number; issueCount?: { issueCountByCategory?: object[]; issueCountByComponent?: object[]; issueCountBySeverity?: { critical?: number; minor?: number; moderate?: number; serious?: number; }; issueCountByURL?: object[]; }; issueSummary?: { componentCount?: number; issueCount?: number; pageCount?: number; }; name?: string; needsReview?: boolean; scanType?: string; scoreData?: { impact?: { critical?: number; minor?: number; moderate?: number; serious?: number; }; score?: number; }; status?: string; time?: string; wcagVersion?: string; }>

Defined in: openapi/generated/accessibility.client.ts:91

Returns the summary for a specific Workflow Analyzer report, including score, issue counts, and scan metadata.

Parameters

Parameter	Type
reportId	number
options?	ExecuteOptions

Returns

Promise<{ advanced?: boolean; bestPractices?: boolean; createdBy?: { name?: string; userId?: number; }; engineInfo?: { name?: string; version?: string; }; id?: number; issueCount?: { issueCountByCategory?: object[]; issueCountByComponent?: object[]; issueCountBySeverity?: { critical?: number; minor?: number; moderate?: number; serious?: number; }; issueCountByURL?: object[]; }; issueSummary?: { componentCount?: number; issueCount?: number; pageCount?: number; }; name?: string; needsReview?: boolean; scanType?: string; scoreData?: { impact?: { critical?: number; minor?: number; moderate?: number; serious?: number; }; score?: number; }; status?: string; time?: string; wcagVersion?: string; }>

Inherited from

GeneratedAccessibilityClient.getWorkflowAnalyzerReportSummary