Class ApiBase<C>

Protectedaxios

Protectedheaders

• get headers(): Record<string, string>

• Returns Record<string, string>

Protectedquery

• get query(): string

• Returns string

Protectedroot

• get root(): string

• Returns string

ProtecteddeleteEndpoint

• deleteEndpoint<T = unknown>(endPoint?: string): Promise<ApiResponseBody<T>>

• Type Parameters

  • T = unknown

  Parameters

  • OptionalendPoint: string

  Returns Promise<ApiResponseBody<T>>

• deleteEndpoint<T = unknown>(
      endPoint?: string,
      responseType?: "body",
  ): Promise<ApiResponseBody<T>>

• Type Parameters

  • T = unknown

  Parameters

  • OptionalendPoint: string
  • OptionalresponseType: "body"

  Returns Promise<ApiResponseBody<T>>

• deleteEndpoint<T = unknown>(
      endPoint?: string,
      responseType?: "tuple",
  ): Promise<ApiResponseTuple<T>>

• Type Parameters

  • T = unknown

  Parameters

  • OptionalendPoint: string
  • OptionalresponseType: "tuple"

  Returns Promise<ApiResponseTuple<T>>

ProtectedgetEndpoint

• getEndpoint<T = unknown>(endPoint?: string): Promise<ApiResponseBody<T>>

• Type Parameters

  • T = unknown

  Parameters

  • OptionalendPoint: string

  Returns Promise<ApiResponseBody<T>>

• getEndpoint<T = unknown>(
      endPoint?: string,
      responseType?: "body",
  ): Promise<ApiResponseBody<T>>

• Type Parameters

  • T = unknown

  Parameters

  • OptionalendPoint: string
  • OptionalresponseType: "body"

  Returns Promise<ApiResponseBody<T>>

• getEndpoint<T = unknown>(
      endPoint?: string,
      responseType?: "tuple",
  ): Promise<ApiResponseTuple<T>>

• Type Parameters

  • T = unknown

  Parameters

  • OptionalendPoint: string
  • OptionalresponseType: "tuple"

  Returns Promise<ApiResponseTuple<T>>

ProtectedhandleMonitorResponseError

• handleMonitorResponseError<T>(
      error: ApiError,
      trapAxiosException: boolean,
  ): undefined | ApiResponse<ApiEnvelope<T>>

• Type Parameters

  • T

  Parameters

  • error: ApiError
  • trapAxiosException: boolean

  Returns undefined | ApiResponse<ApiEnvelope<T>>

ProtectedmonitorResponse

• monitorResponse<T>(
      closure: () => Promise<ApiResponse<ApiEnvelope<T>>>,
  ): Promise<undefined | ApiResponse<ApiEnvelope<T>>>

• Type Parameters

  • T

  Parameters

  • closure: () => Promise<ApiResponse<ApiEnvelope<T>>>

  Returns Promise<undefined | ApiResponse<ApiEnvelope<T>>>

ProtectedpostEndpoint

• postEndpoint<T = unknown, D = unknown>(
      endPoint?: string,
      data?: D,
  ): Promise<ApiResponseBody<T>>

• Type Parameters

  • T = unknown
  • D = unknown

  Parameters

  • OptionalendPoint: string
  • Optionaldata: D

  Returns Promise<ApiResponseBody<T>>

• postEndpoint<T = unknown, D = unknown>(
      endPoint?: string,
      data?: D,
      responseType?: "body",
  ): Promise<ApiResponseBody<T>>

• Type Parameters

  • T = unknown
  • D = unknown

  Parameters

  • OptionalendPoint: string
  • Optionaldata: D
  • OptionalresponseType: "body"

  Returns Promise<ApiResponseBody<T>>

• postEndpoint<T = unknown, D = unknown>(
      endPoint?: string,
      data?: D,
      responseType?: "tuple",
  ): Promise<ApiResponseTuple<T>>

• Type Parameters

  • T = unknown
  • D = unknown

  Parameters

  • OptionalendPoint: string
  • Optionaldata: D
  • OptionalresponseType: "tuple"

  Returns Promise<ApiResponseTuple<T>>

ProtectedputEndpoint

• putEndpoint<T = unknown, D = unknown>(
      endPoint?: string,
      data?: D,
  ): Promise<ApiResponseBody<T>>

• Type Parameters

  • T = unknown
  • D = unknown

  Parameters

  • OptionalendPoint: string
  • Optionaldata: D

  Returns Promise<ApiResponseBody<T>>

• putEndpoint<T = unknown, D = unknown>(
      endPoint?: string,
      data?: D,
      responseType?: "body",
  ): Promise<ApiResponseBody<T>>

• Type Parameters

  • T = unknown
  • D = unknown

  Parameters

  • OptionalendPoint: string
  • Optionaldata: D
  • OptionalresponseType: "body"

  Returns Promise<ApiResponseBody<T>>

• putEndpoint<T = unknown, D = unknown>(
      endPoint?: string,
      data?: D,
      responseType?: "tuple",
  ): Promise<ApiResponseTuple<T>>

• Type Parameters

  • T = unknown
  • D = unknown

  Parameters

  • OptionalendPoint: string
  • Optionaldata: D
  • OptionalresponseType: "tuple"

  Returns Promise<ApiResponseTuple<T>>