Documentation / core / APIClient

Class: APIClient

Defined in: packages/core/src/api-client.ts:48

Internal

Extended by

• GeneratedAutomateClient

Constructors

Constructor

new APIClient(options, baseUrl, cloudBaseUrl, pkgName, pkgVersion): APIClient

Defined in: packages/core/src/api-client.ts:59

Parameters

Parameter	Type
options	BrowserStackOptions
baseUrl	string
cloudBaseUrl	string
pkgName	string
pkgVersion	string

Returns

APIClient

Properties

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

Methods

execute()

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

Defined in: packages/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>