Class BaseClient

Hierarchy

BaseClient

Index

Properties

dataSource

dataSource: DataSourceClient

Constructors

constructor

new BaseClient(baseUrl: string, headers: Record<string, string>, tokenManager: TokenManager, orgId: string, loggerConfig?: LoggerConfig): BaseClient
Creates an instance of BaseClient.

Example
```
const client = new BaseClient('https://webexapis.com/v1', { 'Your-Custom-Header': 'some value' }, tokenManager, 'org123');
```
Parameters
- baseUrl: string
  
  The base URL for the API.
- headers: Record<string, string>
  
  The additional headers to be used in requests.
- tokenManager: TokenManager
  
  The token manager instance.
- orgId: string
  
  The organization ID.
- loggerConfig: LoggerConfig = DEFAULT_LOGGER_CONFIG
Returns BaseClient

Methods

request

request<T>(endpoint: string, options??: HttpRequestInit): Promise<ApiResponse<T>>
Makes an HTTP request.

Returns
- The API response.
Example
```
const response = await client.request('/endpoint', { method: 'GET', headers: {} });
```
Type Parameters
- T
Parameters
- endpoint: string
  
  The API endpoint.
- Optional options: HttpRequestInit = {}
  
  The request options.
Returns Promise<ApiResponse<T>>

post

post<T>(endpoint: string, body: Record<string, any>, headers??: Record<string, string>): Promise<ApiResponse<T>>
Makes a POST request.

Returns
- The API response.
Example
```
const response = await client.post('/endpoint', { key: 'value' });
```
Type Parameters
- T
Parameters
- endpoint: string
  
  The API endpoint.
- body: Record<string, any>
  
  The request body.
- Optional headers: Record<string, string> = {}
  
  The request headers.
Returns Promise<ApiResponse<T>>

put

put<T>(endpoint: string, body: Record<string, any>, headers?: Record<string, string>): Promise<ApiResponse<T>>
Makes a PUT request.

Returns
- The API response.
Example
```
const response = await client.put('/endpoint', { key: 'value' });
```
Type Parameters
- T
Parameters
- endpoint: string
  
  The API endpoint.
- body: Record<string, any>
  
  The request body.
- headers: Record<string, string> = {}
Returns Promise<ApiResponse<T>>

patch

patch<T>(endpoint: string, body: Record<string, any>, headers?: Record<string, string>): Promise<ApiResponse<T>>
Makes a PATCH request.

Returns
- The API response.
Example
```
const response = await client.patch('/endpoint', { key: 'value' });
```
Type Parameters
- T
Parameters
- endpoint: string
  
  The API endpoint.
- body: Record<string, any>
  
  The request body.
- headers: Record<string, string> = {}
Returns Promise<ApiResponse<T>>

get

get<T>(endpoint: string, headers?: Record<string, string>): Promise<ApiResponse<T>>
Makes a GET request.

Returns
- The API response.
Example
```
const response = await client.get('/endpoint');
```
Type Parameters
- T
Parameters
- endpoint: string
  
  The API endpoint.
- headers: Record<string, string> = {}
Returns Promise<ApiResponse<T>>

delete

delete<T>(endpoint: string, headers?: Record<string, string>): Promise<ApiResponse<T>>
Makes a DELETE request.

Returns
- The API response.
Example
```
const response = await client.delete('/endpoint');
```
Type Parameters
- T
Parameters
- endpoint: string
  
  The API endpoint.
- headers: Record<string, string> = {}
Returns Promise<ApiResponse<T>>

getHttpClientForOrg

getHttpClientForOrg(): HttpClient
Get an HTTP client for a specific organization.

Returns
- An object containing methods for making HTTP requests.
Example
```
const httpClient = client.getHttpClientForOrg();
const response = await httpClient.get('/endpoint');
```
Returns HttpClient

Class BaseClient

Hierarchy

Index

Properties

Constructors

Methods

Properties

dataSource

Constructors

constructor

Example

Parameters

baseUrl: string

headers: Record<string, string>

tokenManager: TokenManager

orgId: string

loggerConfig: LoggerConfig = DEFAULT_LOGGER_CONFIG

Returns BaseClient

Methods

request

Returns

Example

Type Parameters

T

Parameters

endpoint: string

Optional options: HttpRequestInit = {}

Returns Promise<ApiResponse<T>>

post

Returns

Example

Type Parameters

T

Parameters

endpoint: string

body: Record<string, any>

Optional headers: Record<string, string> = {}

Returns Promise<ApiResponse<T>>

put

Returns

Example

Type Parameters

T

Parameters

endpoint: string

body: Record<string, any>

headers: Record<string, string> = {}

Returns Promise<ApiResponse<T>>

patch

Returns

Example

Type Parameters

T

Parameters

endpoint: string

body: Record<string, any>

headers: Record<string, string> = {}

Returns Promise<ApiResponse<T>>

get

Returns

Example

Type Parameters

T

Parameters

endpoint: string

headers: Record<string, string> = {}

Returns Promise<ApiResponse<T>>

delete

Returns

Example

Type Parameters

T

Parameters

endpoint: string

headers: Record<string, string> = {}

Returns Promise<ApiResponse<T>>

getHttpClientForOrg

Returns

Example

Returns HttpClient

`Optional` options: HttpRequestInit = {}

`Optional` headers: Record<string, string> = {}