perspectapi-ts-sdk

Classes

• HttpClient

Functions

• createApiError

---

Function: createApiError()

createApiError(error): ApiError

Create API Error from unknown error

Parameters

error

unknown

Returns

ApiError

---

Class: HttpClient

Constructors

Constructor

new HttpClient(config): HttpClient

Parameters

config

PerspectApiConfig

Returns

HttpClient

Methods

clearAuth()

clearAuth(): void

Remove authentication

Returns

void

delete()

delete<T>(endpoint, options?): Promise<ApiResponse<T>>

DELETE request

Type Parameters

T

T = any

Parameters

endpoint

string

options?

Partial<RequestOptions>

Returns

Promise<ApiResponse<T>>

get()

get<T>(endpoint, params?): Promise<ApiResponse<T>>

GET request

Type Parameters

T

T = any

Parameters

endpoint

string

params?

Record<string, any>

Returns

Promise<ApiResponse<T>>

patch()

patch<T>(endpoint, body?, options?): Promise<ApiResponse<T>>

PATCH request

Type Parameters

T

T = any

Parameters

endpoint

string

body?

any

options?

Partial<RequestOptions>

Returns

Promise<ApiResponse<T>>

post()

post<T>(endpoint, body?, options?): Promise<ApiResponse<T>>

POST request

Type Parameters

T

T = any

Parameters

endpoint

string

body?

any

options?

Partial<RequestOptions>

Returns

Promise<ApiResponse<T>>

put()

put<T>(endpoint, body?, options?): Promise<ApiResponse<T>>

PUT request

Type Parameters

T

T = any

Parameters

endpoint

string

body?

any

options?

Partial<RequestOptions>

Returns

Promise<ApiResponse<T>>

request()

request<T>(endpoint, options?): Promise<ApiResponse<T>>

Make HTTP request with retry logic

Type Parameters

T

T = any

Parameters

endpoint

string

options?

RequestOptions = {}

Returns

Promise<ApiResponse<T>>

setApiKey()

setApiKey(apiKey): void

Update API key

Parameters

apiKey

string

Returns

void

setAuth()

setAuth(jwt): void

Update authentication token

Parameters

jwt

string

Returns

void