Class RequestClient

Index

Constructors

Methods

deleteRequest getRequest multiPatchRequest multiPostRequest multiPutRequest patchRequest postRequest putRequest

Constructors

constructor

new RequestClient(
    key: string,
    baseUrl: string,
    logger?: ConfigLogger,
): RequestClient
Parameters
- key: string
- baseUrl: string
- Optionallogger: ConfigLogger
Returns RequestClient

Methods

deleteRequest

deleteRequest<T>(
    endpoint: string,
    payload?: Record<string, any>,
    returnFullResponse?: boolean,
): Promise<T>
Type Parameters
- T
Parameters
- endpoint: string
- payload: Record<string, any> = {}
- returnFullResponse: boolean = false
Returns Promise<T>

getRequest

getRequest<T>(
    endpoint: string,
    payload?: Record<string, any>,
    returnFullResponse?: boolean,
): Promise<T>
Type Parameters
- T
Parameters
- endpoint: string
- payload: Record<string, any> = {}
- returnFullResponse: boolean = false
Returns Promise<T>

multiPatchRequest

multiPatchRequest<T>(
    endpoint: string,
    payload: FormData,
    returnFullResponse?: boolean,
): Promise<T>
Type Parameters
- T
Parameters
- endpoint: string
- payload: FormData
- returnFullResponse: boolean = false
Returns Promise<T>

multiPostRequest

multiPostRequest<T>(
    endpoint: string,
    payload: FormData,
    returnFullResponse?: boolean,
): Promise<T>
Type Parameters
- T
Parameters
- endpoint: string
- payload: FormData
- returnFullResponse: boolean = false
Returns Promise<T>

multiPutRequest

multiPutRequest<T>(
    endpoint: string,
    payload: FormData,
    returnFullResponse?: boolean,
): Promise<T>
Type Parameters
- T
Parameters
- endpoint: string
- payload: FormData
- returnFullResponse: boolean = false
Returns Promise<T>

patchRequest

patchRequest<T>(
    endpoint: string,
    payload?: Record<string, any>,
    returnFullResponse?: boolean,
): Promise<T>
Type Parameters
- T
Parameters
- endpoint: string
- payload: Record<string, any> = {}
- returnFullResponse: boolean = false
Returns Promise<T>

postRequest

postRequest<T>(
    endpoint: string,
    payload?: Record<string, any>,
    returnFullResponse?: boolean,
): Promise<T>
Type Parameters
- T
Parameters
- endpoint: string
- payload: Record<string, any> = {}
- returnFullResponse: boolean = false
Returns Promise<T>

putRequest

putRequest<T>(
    endpoint: string,
    payload?: Record<string, any>,
    returnFullResponse?: boolean,
): Promise<T>
Type Parameters
- T
Parameters
- endpoint: string
- payload: Record<string, any> = {}
- returnFullResponse: boolean = false
Returns Promise<T>