Class ApiClient

The client for interacting with the Donation Alerts API.

Index

Constructors

Accessors

centrifugo customAlerts donations merchandise users

Methods

Constructors

constructor

new ApiClient(config: ApiConfig): ApiClient
Creates a new instance of the API client.
Parameters
- config: ApiConfig
  The configuration options for the API client.
Returns ApiClient
Throws
Error if the authProvider is not supplied in the configuration.
- Defined in api/src/api-client.ts:119

Accessors

centrifugo

get centrifugo(): DonationAlertsCentrifugoApi
Centrifugo API namespace.

This namespace provides methods for subscribing to Centrifugo channels.

Returns DonationAlertsCentrifugoApi
- Defined in api/src/api-client.ts:188

customAlerts

get customAlerts(): DonationAlertsCustomAlertsApi
Custom Alerts API namespace.

This namespace provides methods for sending custom alerts.

Returns DonationAlertsCustomAlertsApi
- Defined in api/src/api-client.ts:177

donations

get donations(): DonationAlertsDonationsApi
Donations API namespace.

This namespace provides methods for retrieving donation data.

Returns DonationAlertsDonationsApi
- Defined in api/src/api-client.ts:167

merchandise

get merchandise(): DonationAlertsMerchandiseApi
Merchandise API namespace.

This namespace allows managing merchandise-related data.

Returns DonationAlertsMerchandiseApi
- Defined in api/src/api-client.ts:198

users

get users(): DonationAlertsUsersApi
Users API namespace.

This namespace allows you to fetch user details, such as information about the authenticated user.

Returns DonationAlertsUsersApi
- Defined in api/src/api-client.ts:157

Methods

callApi

callApi<T = unknown>(
    user: UserIdResolvable,
    options: DonationAlertsApiCallOptions,
    rateLimiterOptions?: RateLimiterRequestOptions,
): Promise<T>
Sends a request to the Donation Alerts API.
Type Parameters
- T = unknown
Parameters
- user: UserIdResolvable
  The ID of the user making the request.
- options: DonationAlertsApiCallOptions
  Options for the API call, including method, URL, and other details.
- rateLimiterOptions: RateLimiterRequestOptions = {}
  Options for fine-tuning rate-limiting behavior.
Returns Promise<T>
Throws
HttpError If the response status code is outside the 200-299 range.

Throws
UnregisteredUserError If the specified user is not registered in the authentication provider.

Throws
MissingScopeError If the access token lacks the required scope to complete the request.
- Defined in api/src/api-client.ts:213