@donation-alerts/api/es/api/donations/donation-alerts-donations-api.mjs

Interact with Donation Alerts API.

import { __decorate } from "tslib";
import { ReadDocumentation } from '@donation-alerts/common';
import { DonationAlertsDonation } from "./donation-alerts-donation.mjs";
import { BaseApi } from "../base-api.mjs";
import { DonationAlertsApiPaginator } from "../donation-alerts-api-paginator.mjs";
/**
 * Donation Alerts Donations API.
 *
 * @remarks
 * This API provides functionality to fetch donations associated with a streamer’s account.
 * It supports fetching donations page-by-page, retrieving all donations, and working with paginators
 * for more flexible data handling.
 *
 * The API methods require the `oauth-donation-index` scope to access the data.
 */
let DonationAlertsDonationsApi = class DonationAlertsDonationsApi extends BaseApi {
    /**
     * Fetches a single page of donation data for a specified user.
     *
     * @remarks
     * Requires the `oauth-donation-index` scope.
     *
     * If no pagination options are provided, it defaults to the first page.
     *
     * @param user The ID of the user to fetch donations for.
     * @param pagination Pagination options (e.g., page number to retrieve).
     * @param rateLimiterOptions Optional Rate Limiter configuration.
     *
     * @returns A promise that resolves to an array of {@link DonationAlertsDonation} objects.
     *
     * @throws {@link HttpError} if the HTTP status code is outside the range of 200–299.
     * @throws {@link UnregisteredUserError} if the user is not registered in the authentication provider.
     * @throws {@link MissingScopeError} if the access token lacks the `oauth-donation-index` scope.
     *
     * @example
     * ```typescript
     * const donations = await apiClient.donations.getDonations(userId, { page: 1 });
     * donations.forEach(donation => console.log(donation.username, donation.amount, donation.currency));
     * ```
     */
    async getDonations(user, pagination = {}, rateLimiterOptions) {
        const page = typeof pagination.page === 'number' && pagination.page !== 0 ? pagination.page : 1;
        const response = await this._apiClient.callApi(user, {
            type: 'api',
            url: 'alerts/donations',
            method: 'GET',
            scope: 'oauth-donation-index',
            query: { page },
            auth: true,
        }, rateLimiterOptions);
        return response.data.map(donation => new DonationAlertsDonation(donation));
    }
    /**
     * Fetches **all** donations associated with the specified user.
     *
     * @remarks
     * Requires the `oauth-donation-index` scope.
     *
     * This method retrieves all donation data for a user and may take longer to execute, especially
     * for users with a large volume of donations. For better performance with large datasets, consider
     * using the {@link DonationAlertsDonationsApi#createDonationsPaginator} method to fetch data in chunks.
     *
     * @param user The ID of the user to fetch all donations for.
     * @param rateLimiterOptions Optional Rate Limiter configuration.
     *
     * @returns A promise that resolves to an array of {@link DonationAlertsDonation} objects.
     *
     * @throws {@link HttpError} if the API response returns a non-200 status code.
     * @throws {@link UnregisteredUserError} if the user is not registered in the authentication provider.
     * @throws {@link MissingScopeError} if the access token lacks the `oauth-donation-index` scope.
     *
     * @example
     * ```ts
     * const allDonations = await apiClient.donations.getAllDonations(userId);
     * console.log(`Retrieved ${allDonations.length} donations.`);
     * ```
     */
    async getAllDonations(user, rateLimiterOptions) {
        return await this.createDonationsPaginator(user, rateLimiterOptions).getAll();
    }
    /**
     * Creates a paginator for fetching donation data.
     *
     * The paginator provides flexibility by allowing you to fetch donation data page-by-page.
     * This is especially useful for handling large datasets incrementally.
     *
     * @remarks
     * Requires the `oauth-donation-index` scope.
     *
     * @param user The ID of the user to fetch donations for.
     * @param rateLimiterOptions Optional Rate Limiter configuration.
     *
     * @returns A {@link DonationAlertsApiPaginator} instance for donations.
     *
     * @example
     * Fetch the next page
     *
     * ```ts
     * const paginator = apiClient.donations.createDonationsPaginator(userId);
     * const firstPage = await paginator.getNext();
     * console.log(firstPage.data); // donations from the first page
     * ```
     *
     * @example
     * Iterate over paginator
     *
     * ```ts
     * const paginator = apiClient.donations.createDonationsPaginator(userId);
     *
     * for await (const pageDonations of paginator) {
     *     console.log(pageDonations);
     * }
     * ```
     */
    createDonationsPaginator(user, rateLimiterOptions) {
        return new DonationAlertsApiPaginator(this._apiClient, user, {
            type: 'api',
            url: 'alerts/donations',
            method: 'GET',
            scope: 'oauth-donation-index',
            auth: true,
        }, donation => new DonationAlertsDonation(donation), rateLimiterOptions);
    }
};
DonationAlertsDonationsApi = __decorate([
    ReadDocumentation('api')
], DonationAlertsDonationsApi);
export { DonationAlertsDonationsApi };