Class ClientBuilder

Index

Constructors

Methods

build defaultClient withAfterExecutionMiddleware withAnonymousSessionFlow withAuthMiddleware withBeforeExecutionMiddleware withClientCredentialsFlow withCorrelationIdMiddleware withExistingTokenFlow withHttpMiddleware withLoggerMiddleware withMiddleware withPasswordFlow withProjectKey withQueueMiddleware withRefreshTokenFlow withTelemetryMiddleware withUserAgentMiddleware

Constructors

constructor

new ClientBuilder(): ClientBuilder
Returns ClientBuilder

Methods

build

build(): Client
Returns Client
- Defined in client-builder/ClientBuilder.ts:229

defaultClient

defaultClient(
    baseUri: string,
    credentials: Credentials,
    oauthUri?: string,
    projectKey?: string,
): ClientBuilder
Parameters
- baseUri: string
- credentials: Credentials
- OptionaloauthUri: string
- OptionalprojectKey: string
Returns ClientBuilder
- Defined in client-builder/ClientBuilder.ts:54

withAfterExecutionMiddleware

withAfterExecutionMiddleware(
options: AfterExecutionMiddlewareOptions,
): ClientBuilder
Parameters
- options: AfterExecutionMiddlewareOptions
Returns ClientBuilder
- Defined in client-builder/ClientBuilder.ts:223

withAnonymousSessionFlow

withAnonymousSessionFlow(options: AnonymousAuthMiddlewareOptions): ClientBuilder
Parameters
- options: AnonymousAuthMiddlewareOptions
Returns ClientBuilder
- Defined in client-builder/ClientBuilder.ts:119

withAuthMiddleware

withAuthMiddleware(authMiddleware: Middleware): ClientBuilder
Parameters
- authMiddleware: Middleware
Returns ClientBuilder
- Defined in client-builder/ClientBuilder.ts:73

withBeforeExecutionMiddleware

withBeforeExecutionMiddleware(
options: BeforeExecutionMiddlewareOptions,
): ClientBuilder
Parameters
- options: BeforeExecutionMiddlewareOptions
Returns ClientBuilder
- Defined in client-builder/ClientBuilder.ts:217

withClientCredentialsFlow

withClientCredentialsFlow(options: AuthMiddlewareOptions): ClientBuilder
Parameters
- options: AuthMiddlewareOptions
Returns ClientBuilder
- Defined in client-builder/ClientBuilder.ts:83

withCorrelationIdMiddleware

withCorrelationIdMiddleware(
options: CorrelationIdMiddlewareOptions,
): ClientBuilder
Parameters
- options: CorrelationIdMiddlewareOptions
Returns ClientBuilder
- Defined in client-builder/ClientBuilder.ts:195

withExistingTokenFlow

withExistingTokenFlow(
authorization: string,
options?: ExistingTokenMiddlewareOptions,
): ClientBuilder
Parameters
- authorization: string
- Optionaloptions: ExistingTokenMiddlewareOptions
Returns ClientBuilder
- Defined in client-builder/ClientBuilder.ts:153

withHttpMiddleware

withHttpMiddleware(options: HttpMiddlewareOptions): ClientBuilder
Parameters
- options: HttpMiddlewareOptions
Returns ClientBuilder
- Defined in client-builder/ClientBuilder.ts:165

withLoggerMiddleware

withLoggerMiddleware(options?: LoggerMiddlewareOptions): ClientBuilder
Parameters
- Optionaloptions: LoggerMiddlewareOptions
Returns ClientBuilder
- Defined in client-builder/ClientBuilder.ts:187

withMiddleware

withMiddleware(middleware: Middleware): ClientBuilder
Parameters
- middleware: Middleware
Returns ClientBuilder
- Defined in client-builder/ClientBuilder.ts:78

withPasswordFlow

withPasswordFlow(options: PasswordAuthMiddlewareOptions): ClientBuilder
Parameters
- options: PasswordAuthMiddlewareOptions
Returns ClientBuilder
- Defined in client-builder/ClientBuilder.ts:100

withProjectKey

withProjectKey(key: string): ClientBuilder
Parameters
- key: string
Returns ClientBuilder
- Defined in client-builder/ClientBuilder.ts:49

withQueueMiddleware

withQueueMiddleware(options: QueueMiddlewareOptions): ClientBuilder
Parameters
- options: QueueMiddlewareOptions
Returns ClientBuilder
- Defined in client-builder/ClientBuilder.ts:179

withRefreshTokenFlow

withRefreshTokenFlow(options: RefreshAuthMiddlewareOptions): ClientBuilder
Parameters
- options: RefreshAuthMiddlewareOptions
Returns ClientBuilder
- Defined in client-builder/ClientBuilder.ts:137

withTelemetryMiddleware

withTelemetryMiddleware<T extends TelemetryOptions>(options: T): ClientBuilder
Type Parameters
- T extends TelemetryOptions
Parameters
- options: T
Returns ClientBuilder
- Defined in client-builder/ClientBuilder.ts:205

withUserAgentMiddleware

withUserAgentMiddleware(options?: HttpUserAgentOptions): ClientBuilder
Parameters
- Optionaloptions: HttpUserAgentOptions
Returns ClientBuilder
- Defined in client-builder/ClientBuilder.ts:174