Class RestClient

Hierarchy

Constructors

  • Create a new REST client

    Parameters

    • config: Partial<ApiClientConfig>

      API client configuration

    • _restConfig: Record<string, unknown> = {}

      REST client specific configuration

    Returns RestClient

Methods

  • Add an error interceptor

    TODO: [bfcli] Add unit test for error interceptor registration. TODO: [bfcli] Add integration test for error handling flow. TODO: [bfcli] Add OpenAPI doc for interceptor usage (if exposed). TODO: [bfcli] Add error handling for invalid interceptors.

    Parameters

    Returns void

  • Add a request interceptor

    TODO: [bfcli] Add unit test for request interceptor registration. TODO: [bfcli] Add integration test for interceptor execution order. TODO: [bfcli] Add OpenAPI doc for interceptor usage (if exposed). TODO: [bfcli] Add error handling for invalid interceptors.

    Parameters

    Returns void

  • Add a response interceptor

    TODO: [bfcli] Add unit test for response interceptor registration. TODO: [bfcli] Add integration test for response transformation. TODO: [bfcli] Add OpenAPI doc for interceptor usage (if exposed). TODO: [bfcli] Add error handling for invalid interceptors.

    Parameters

    Returns void

  • Make a GET request with query parameters

    Type Parameters

    • T

    Parameters

    • path: string

      Request path

    • query: Record<string, unknown>

      Query parameters

    • options: Omit<RestRequestOptions, "query"> = {}

      Request options

    Returns Promise<ApiResponse<T>>

    Promise resolving to the response

  • Make a POST request with form data

    Type Parameters

    • T

    Parameters

    • path: string

      Request path

    • formData: FormData

      Form data

    • options: Omit<RestRequestOptions, "formData"> = {}

      Request options

    Returns Promise<ApiResponse<T>>

    Promise resolving to the response

  • Make a PUT request with form data

    Type Parameters

    • T

    Parameters

    • path: string

      Request path

    • formData: FormData

      Form data

    • options: Omit<RestRequestOptions, "formData"> = {}

      Request options

    Returns Promise<ApiResponse<T>>

    Promise resolving to the response

  • Make a request with query parameters

    Type Parameters

    • T

    Parameters

    • path: string

      Request path

    • method: HttpMethod

      HTTP method

    • query: Record<string, unknown>

      Query parameters

    • options: Omit<RestRequestOptions, "query"> = {}

      Request options

    Returns Promise<ApiResponse<T>>

    Promise resolving to the response

Generated using TypeDoc