Class ApiClient

ApiClient facilitates making HTTP API requests to external integrations, supporting various HTTP methods such as GET, POST, PUT, PATCH, and DELETE.

Index

Methods

delete get patch post put request

Methods

delete

delete<ResponseBodyType = unknown, RequestBodyType = unknown>(
    integrationId: string,
    endpointId: string,
    body?: RequestBodyType,
    options?: ApiOptions,
): Promise<HttpResponse<ResponseBodyType>>
Sends a DELETE request to the specified integration endpoint.
Type Parameters
- ResponseBodyType = unknown
- RequestBodyType = unknown
Parameters
- integrationId: string
  The integration to send the request to.
- endpointId: string
  The API endpoint to call.
- Optionalbody: RequestBodyType
  Optional request body to send.
- Optionaloptions: ApiOptions
  Optional API request options (headers, query params, etc).
Returns Promise<HttpResponse<ResponseBodyType>>
A promise resolving to the HTTP response.

get

get<ResponseBodyType = unknown>(
    integrationId: string,
    endpointId: string,
    options?: ApiOptions,
): Promise<HttpResponse<ResponseBodyType>>
Sends a GET request to the specified integration endpoint.
Type Parameters
- ResponseBodyType = unknown
Parameters
- integrationId: string
  The integration to send the request to.
- endpointId: string
  The API endpoint to call.
- Optionaloptions: ApiOptions
  Optional API request options (headers, query params, etc).
Returns Promise<HttpResponse<ResponseBodyType>>
A promise resolving to the HTTP response.

patch

patch<ResponseBodyType = unknown, RequestBodyType = unknown>(
    integrationId: string,
    endpointId: string,
    body?: RequestBodyType,
    options?: ApiOptions,
): Promise<HttpResponse<ResponseBodyType>>
Sends a PATCH request to the specified integration endpoint.
Type Parameters
- ResponseBodyType = unknown
- RequestBodyType = unknown
Parameters
- integrationId: string
  The integration to send the request to.
- endpointId: string
  The API endpoint to call.
- Optionalbody: RequestBodyType
  Optional request body to send.
- Optionaloptions: ApiOptions
  Optional API request options (headers, query params, etc).
Returns Promise<HttpResponse<ResponseBodyType>>
A promise resolving to the HTTP response.

post

post<ResponseBodyType = unknown, RequestBodyType = unknown>(
    integrationId: string,
    endpointId: string,
    body?: RequestBodyType,
    options?: ApiOptions,
): Promise<HttpResponse<ResponseBodyType>>
Sends a POST request to the specified integration endpoint.
Type Parameters
- ResponseBodyType = unknown
- RequestBodyType = unknown
Parameters
- integrationId: string
  The integration to send the request to.
- endpointId: string
  The API endpoint to call.
- Optionalbody: RequestBodyType
  Optional request body to send.
- Optionaloptions: ApiOptions
  Optional API request options (headers, query params, etc).
Returns Promise<HttpResponse<ResponseBodyType>>
A promise resolving to the HTTP response.

put

put<ResponseBodyType = unknown, RequestBodyType = unknown>(
    integrationId: string,
    endpointId: string,
    body?: RequestBodyType,
    options?: ApiOptions,
): Promise<HttpResponse<ResponseBodyType>>
Sends a PUT request to the specified integration endpoint.
Type Parameters
- ResponseBodyType = unknown
- RequestBodyType = unknown
Parameters
- integrationId: string
  The integration to send the request to.
- endpointId: string
  The API endpoint to call.
- Optionalbody: RequestBodyType
  Optional request body to send.
- Optionaloptions: ApiOptions
  Optional API request options (headers, query params, etc).
Returns Promise<HttpResponse<ResponseBodyType>>
A promise resolving to the HTTP response.

request

request<ResponseBodyType = unknown, RequestBodyType = unknown>(
    integrationId: string,
    endpointId: string,
    body?: RequestBodyType,
    options?: ApiOptions,
    method?: HttpMethod,
): Promise<HttpResponse<ResponseBodyType>>
Performs an HTTP API request to the given integration ID and endpoint ID. The provided options will be merged with the default options. In case of error (status code >= 400 or other error), the promise will be rejected with an RpcError.
Type Parameters
- ResponseBodyType = unknown
- RequestBodyType = unknown
Parameters
- integrationId: string
- endpointId: string
- Optionalbody: RequestBodyType
- Optionaloptions: ApiOptions
- Optionalmethod: HttpMethod
Returns Promise<HttpResponse<ResponseBodyType>>