Class DonationAlertsDonationsApi

Donation Alerts Donations API.

Allows fetching donations.

Hierarchy

BaseApi
- DonationAlertsDonationsApi

Index

Methods

createDonationsPaginator getAllDonations getDonations

Methods

createDonationsPaginator

createDonationsPaginator(user, rateLimiterOptions?): DonationAlertsApiPaginator<DonationAlertsDonationData, DonationAlertsDonation>
Creates the flexible donations API paginator that allows retrieve donations.

Requires oauth-donation-index scope.
Parameters
- user: UserIdResolvable
  
  The ID of the user to get donations for.
- Optional rateLimiterOptions: RateLimiterRequestOptions
  
  The rate limiter options.
Returns DonationAlertsApiPaginator<DonationAlertsDonationData, DonationAlertsDonation>
- Defined in api/src/api/donations/DonationAlertsDonationsApi.ts:84

getAllDonations

getAllDonations(user, rateLimiterOptions?): Promise<DonationAlertsDonation[]>
gets all donations.

Note: This method can take a long time and return a large amount of data. Consider using createDonationsPaginator instead to get data partially.

Requires oauth-donation-index scope.
Parameters
- user: UserIdResolvable
  
  The ID of the user to get donations for.
- Optional rateLimiterOptions: RateLimiterRequestOptions
  
  The rate limiter options.
Returns Promise<DonationAlertsDonation[]>

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 oauth-donation-index scope.
- Defined in api/src/api/donations/DonationAlertsDonationsApi.ts:69

getDonations

getDonations(user, pagination?, rateLimiterOptions?): Promise<DonationAlertsDonation[]>
Gets donations.

Allows to specify the number of page to return. Otherwise, retrieves the first page.

Requires oauth-donation-index scope.
Parameters
- user: UserIdResolvable
  
  The ID of the user to get donations for.
- pagination: DonationAlertsApiPagination = {}
  
  Pagination options.
- Optional rateLimiterOptions: RateLimiterRequestOptions
  
  The rate limiter options.
Returns Promise<DonationAlertsDonation[]>

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 oauth-donation-index scope.
- Defined in api/src/api/donations/DonationAlertsDonationsApi.ts:31

Generated using TypeDoc