Class RequestClient

constructor

• new RequestClient(authProvider, logger, timeout?): RequestClient

• Creates a new request client to interact with the CFTools API

  Parameters

  • authProvider: Authentication

    The authentication provider to use for requests
  • logger: AbstractLogger

    The logger to use for logging messages
  • timeout: number = 10000

    The timeout for requests in milliseconds

  Returns RequestClient

timeout

apiUrl

• apiUrl(version, path, params?): string

• Dynamically resolves an URL based on the version, path/endpoint, and parameters

  Parameters

  • version: API_VERSION

    The API_VERSION to use
  • path: string

    The path/endpoint to request
  • Optionalparams: Record<string, string> | URLSearchParams

    The parameters (URLSearchParams) to include in the request

  Returns string

  The resolved URL

delete

• delete<T>(url, isAuthenticating?): Promise<T>

• Perform a DELETE request to the CFTools API

  Type Parameters

  • T

  Parameters

  • url: string

    The URL to request
  • isAuthenticating: boolean = false

    Whether the request is for authentication or not

  Returns Promise<T>

  The parsed (JSON) response from the request

  See

  request

get

• get<T>(url, isAuthenticating?): Promise<T>

• Perform a GET request to the CFTools API

  Type Parameters

  • T

  Parameters

  • url: string

    The URL to request
  • isAuthenticating: boolean = false

    Whether the request is for authentication or not

  Returns Promise<T>

  The parsed (JSON) response from the request

  See

  request

post

• post<T>(url, body, isAuthenticating?): Promise<T>

• Perform a POST request to the CFTools API

  Type Parameters

  • T

  Parameters

  • url: string

    The URL to request
  • body: Record<string, unknown>

    The body of the request
  • isAuthenticating: boolean = false

    Whether the request is for authentication or not

  Returns Promise<T>

  The parsed (JSON) response from the request

  See

  request

put

• put<T>(url, body, isAuthenticating?): Promise<T>

• Perform a PUT request to the CFTools API

  Type Parameters

  • T

  Parameters

  • url: string

    The URL to request
  • body: Record<string, unknown>

    The body of the request
  • isAuthenticating: boolean = false

    Whether the request is for authentication or not

  Returns Promise<T>

  The parsed (JSON) response from the request

  See

  request

request

• request<T>(url, options, isAuthenticating?): Promise<T>

• Perform a request to the CFTools API

  Type Parameters

  • T

  Parameters

  • url: string

    The URL to request
  • options: RequestInit

    The options for the request
  • isAuthenticating: boolean = false

    Whether the request is for authentication or not

  Returns Promise<T>

  The parsed JSON response from the request

  Throws

  Thrown if the request fails

  Throws

  Thrown if the request method is invalid

  Throws

  Thrown if a required parameter is missing

  Throws

  Thrown if a supplied argument failed type validation

  Throws

  Thrown if a supplied option is not available for the selected route

  Throws

  Thrown if the maximum length of a parameter has been exceeded

  Throws

  Thrown if the minimum length of a parameter has not been reached

  Throws

  Thrown if the length of a parameter does not match the expected length

  Throws

  Thrown if a duplicate entry is detected

  Throws

  Thrown if the client is not authenticated

  Throws

  Thrown if the authentication token needs to be regenerated

  Throws

  Thrown if the secret is invalid

  Throws

  Thrown if the token is invalid

  Throws

  Thrown if the token has expired

  Throws

  Thrown if the token has no grant

  Throws

  Thrown if the requested resource was not found

  Throws

  Thrown if the requested resource is invalid

  Throws

  Thrown if the requested bucket is invalid

  Throws

  Thrown if the rate limit has been exceeded

  Throws

  Thrown if an unexpected error occurred

  Throws

  Thrown if the request timed out

  Throws

  Thrown if the system is unavailable

resolveHeaders

• resolveHeaders(headersInit, isAuthenticating?): HeadersInit

• Resolves the headers for a request based on the current state of the client

  Parameters

  • headersInit: HeadersInit

    Initial headers for the request
  • isAuthenticating: boolean = false

    Whether the request is for authentication or not

  Returns HeadersInit

  The resolved headers for the request

resolveRequestOptions

• resolveRequestOptions(url, options, isAuthenticating?): RequestInit

• Resolves the request options for a request depending on the current state of the client

  Parameters

  • url: string

    The URL to request
  • options: RequestInit

    The options for the request
  • isAuthenticating: boolean = false

    Whether the request is for authentication or not

  Returns RequestInit

  The resolved request options