Class ApiClient

The client to interact with Donation Alerts API.

Hierarchy

ApiClient

Index

Constructors

Accessors

centrifugo customAlerts donations merchandise users

Methods

Constructors

constructor

new ApiClient(config): ApiClient
Creates a new API client instance.
Parameters
- config: ApiConfig
  
  The API client configuration.
Returns ApiClient
- Defined in api/src/ApiClient.ts:116

Accessors

centrifugo

get centrifugo(): DonationAlertsCentrifugoApi
Donation Alerts Centrifugo API namespace.

Returns DonationAlertsCentrifugoApi
- Defined in api/src/ApiClient.ts:176

customAlerts

get customAlerts(): DonationAlertsCustomAlertsApi
Donation Alerts Custom Alerts API namespace.

Returns DonationAlertsCustomAlertsApi
- Defined in api/src/ApiClient.ts:168

donations

get donations(): DonationAlertsDonationsApi
Donation Alerts Donations API namespace.

Returns DonationAlertsDonationsApi
- Defined in api/src/ApiClient.ts:160

merchandise

get merchandise(): DonationAlertsMerchandiseApi
Donation Alerts Merchandise API namespace.

Returns DonationAlertsMerchandiseApi
- Defined in api/src/ApiClient.ts:184

users

get users(): DonationAlertsUsersApi
Donation Alerts Users API namespace.

Returns DonationAlertsUsersApi
- Defined in api/src/ApiClient.ts:152

Methods

callApi

callApi<T>(user, options, rateLimiterOptions?): Promise<T>
Makes a call to the Donation Alerts API.
Type Parameters
- T = unknown
Parameters
- user: UserIdResolvable
  
  The ID of the user.
- options: DonationAlertsApiCallOptions
  
  The API call options.
- rateLimiterOptions: RateLimiterRequestOptions = {}
  
  The rate limiter options.
Returns Promise<T>

Throws
HttpError if response status code is out of 200-299 range.

Throws
UnregisteredUserError if the user you are trying to get is not registered in authentication provider.

Throws
MissingScopeError if the access token does not have required scope.
- Defined in api/src/ApiClient.ts:200

Generated using TypeDoc