Documentation / core / APIClient

Class: APIClient

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

Internal

Extended by

• GeneratedAutomateClient

Constructors

Constructor

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

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

Parameters

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

Returns

APIClient

Properties

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

Methods

execute()

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

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