Class BaseClientAbstract

ProtectedaxiosInstance

Protectedconfig

Protected AbstractaddAuthHeaders

• addAuthHeaders(
      config: InternalAxiosRequestConfig,
  ):
      | InternalAxiosRequestConfig<any>
      | Promise<InternalAxiosRequestConfig<any>>

  Abstract method to add authentication headers. Can be async to support token refresh before requests.

  Parameters

  • config: InternalAxiosRequestConfig

  Returns InternalAxiosRequestConfig<any> | Promise<InternalAxiosRequestConfig<any>>

ProtectedbuildRequestConfig

• buildRequestConfig(
      options?: RequestOptions,
      baseConfig?: AxiosRequestConfig<any>,
  ): AxiosRequestConfig

  Build axios config with optional per-request timezone override

  Parameters

  • Optionaloptions: RequestOptions
  • OptionalbaseConfig: AxiosRequestConfig<any>

  Returns AxiosRequestConfig

Protecteddelete

• delete<T>(path: string, options?: RequestOptions): Promise<T>

  Make a DELETE request

  Type Parameters

  • T

  Parameters

  • path: string
  • Optionaloptions: RequestOptions

  Returns Promise<T>

Protectedget

• get<T>(path: string, params?: object, options?: RequestOptions): Promise<T>

  Make a GET request

  Type Parameters

  • T

  Parameters

  • path: string
  • Optionalparams: object
  • Optionaloptions: RequestOptions

  Returns Promise<T>

ProtectedgetRaw

• getRaw(
      path: string,
      params?: object,
      options?: RequestOptions,
      responseType?: "arraybuffer" | "blob" | "stream",
  ): Promise<AxiosResponse<any, any, {}>>

  Make a GET request that returns the full AxiosResponse, including headers and raw data.

  Use this for endpoints that return binary content (e.g. file downloads) where the caller needs access to response headers such as Content-Disposition or Content-Type.

  Parameters

  • path: string

    Request path relative to the client's base URL

  • Optionalparams: object

    Optional query parameters

  • Optionaloptions: RequestOptions

    Optional per-request options (e.g. timezone override)

  • responseType: "arraybuffer" | "blob" | "stream" = 'arraybuffer'

    Axios response type (default: 'arraybuffer')

  Returns Promise<AxiosResponse<any, any, {}>>

  The full axios response

Protectedpatch

• patch<T>(path: string, data?: unknown, options?: RequestOptions): Promise<T>

  Make a PATCH request

  Type Parameters

  • T

  Parameters

  • path: string
  • Optionaldata: unknown
  • Optionaloptions: RequestOptions

  Returns Promise<T>

Protectedpost

• post<T>(path: string, data?: unknown, options?: RequestOptions): Promise<T>

  Make a POST request

  Type Parameters

  • T

  Parameters

  • path: string
  • Optionaldata: unknown
  • Optionaloptions: RequestOptions

  Returns Promise<T>

ProtectedpostForm

• postForm<T>(
      path: string,
      formData: FormData,
      options?: RequestOptions,
  ): Promise<T>

  Make a POST request with multipart/form-data.

  Overrides the default application/json content type so that axios sets the correct multipart/form-data boundary automatically.

  Type Parameters

  • T

  Parameters

  • path: string

    Request path relative to the client's base URL

  • formData: FormData

    A FormData instance containing the fields and files to upload

  • Optionaloptions: RequestOptions

    Optional per-request options (e.g. timezone override)

  Returns Promise<T>

  Parsed response body

Protectedput

• put<T>(path: string, data?: unknown, options?: RequestOptions): Promise<T>

  Make a PUT request

  Type Parameters

  • T

  Parameters

  • path: string
  • Optionaldata: unknown
  • Optionaloptions: RequestOptions

  Returns Promise<T>