Class BaseClient

Hierarchy (View Summary)

BaseClient

Implements

Client

Index

Constructors

constructor

new BaseClient(config: Config): BaseClient
Parameters
- config: Config
Returns BaseClient
- Defined in src/clients/baseClient.ts:16

Properties

`Protected` `Readonly`config

config: Config

Methods

`Protected`encode

encode(value: string): string
Parameters
- value: string
Returns string
- Defined in src/clients/baseClient.ts:70

handleFailedResponse

handleFailedResponse<T>(e: unknown, callback?: Callback<T>): void
Type Parameters
- T
Parameters
- e: unknown
- Optionalcallback: Callback<T>
Returns void
Implementation of Client.handleFailedResponse
- Defined in src/clients/baseClient.ts:121

handleSuccessResponse

handleSuccessResponse<T>(response: any, callback?: Callback<T>): void | T
Type Parameters
- T
Parameters
- response: any
- Optionalcallback: Callback<T>
Returns void | T
Implementation of Client.handleSuccessResponse
- Defined in src/clients/baseClient.ts:110

`Protected`paramSerializer

paramSerializer(parameters: Record<string, any>): string
Parameters
- parameters: Record<string, any>
Returns string
- Defined in src/clients/baseClient.ts:38

`Protected`removeUndefinedProperties

removeUndefinedProperties(obj: Record<string, any>): Record<string, any>
Parameters
- obj: Record<string, any>
Returns Record<string, any>
- Defined in src/clients/baseClient.ts:80

sendRequest

sendRequest<T>(
    requestConfig: RequestConfig,
    callback: never,
    telemetryData?: any,
): Promise<T>
Type Parameters
- T
Parameters
- requestConfig: RequestConfig
- callback: never
- OptionaltelemetryData: any
Returns Promise<T>
Implementation of Client.sendRequest
- Defined in src/clients/baseClient.ts:86
sendRequest<T>(
    requestConfig: RequestConfig,
    callback: Callback<T>,
    telemetryData?: any,
): Promise<void>
Type Parameters
- T
Parameters
- requestConfig: RequestConfig
- callback: Callback<T>
- OptionaltelemetryData: any
Returns Promise<void>
Implementation of Client.sendRequest
- Defined in src/clients/baseClient.ts:87

sendRequestFullResponse

sendRequestFullResponse<T>(
requestConfig: RequestConfig,
): Promise<AxiosResponse<T, any>>
Type Parameters
- T
Parameters
- requestConfig: RequestConfig
Returns Promise<AxiosResponse<T, any>>
Implementation of Client.sendRequestFullResponse
- Defined in src/clients/baseClient.ts:98

Class BaseClient

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns BaseClient

Properties

Protected Readonlyconfig

Methods

Protectedencode

Parameters

Returns string

handleFailedResponse

Type Parameters

Parameters

Returns void

handleSuccessResponse

Type Parameters

Parameters

Returns void | T

ProtectedparamSerializer

Parameters

Returns string

ProtectedremoveUndefinedProperties

Parameters

Returns Record<string, any>

sendRequest

Type Parameters

Parameters

Returns Promise<T>

Type Parameters

Parameters

Returns Promise<void>

sendRequestFullResponse

Type Parameters

Parameters

Returns Promise<AxiosResponse<T, any>>

Settings

On This Page

`Protected` `Readonly`config

`Protected`encode

`Protected`paramSerializer

`Protected`removeUndefinedProperties