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

Interact with Donation Alerts API.

import { __decorate } from "tslib";
import { ReadDocumentation } from '@donation-alerts/common';
import { DonationAlertsUser } from "./donation-alerts-user.mjs";
import { BaseApi } from "../base-api.mjs";
/**
 * Donation Alerts Users API.
 *
 * @remarks
 * Provides methods to interact with Donation Alerts users, including retrieving user profiles
 * and socket connection tokens.
 */
let DonationAlertsUsersApi = class DonationAlertsUsersApi extends BaseApi {
    /**
     * Fetches the authenticated user's information based on the provided user ID.
     *
     * @remarks
     * Requires `oauth-user-show` scope.
     *
     * @param user The ID of the user whose profile needs to be fetched.
     * @param rateLimiterOptions Optional rate limiter configuration to control API requests.
     *
     * @returns A {@link DonationAlertsUser} instance containing the user's profile information.
     *
     * @throws {@link HttpError} if the response status code falls outside the 200–299 range.
     * @throws {@link UnregisteredUserError} if the specified user is not registered in the authentication provider.
     * @throws {@link MissingScopeError} if the provided access token is missing the required `oauth-user-show` scope.
     *
     * @example
     * ```ts
     * const user = await apiClient.users.getUser(userId);
     * console.log(`User ID: ${user.id}, Name: ${user.name}`);
     * ```
     */
    async getUser(user, rateLimiterOptions) {
        const response = await this._apiClient.callApi(user, {
            type: 'api',
            url: 'user/oauth',
            method: 'GET',
            scope: 'oauth-user-show',
            auth: true,
        }, rateLimiterOptions);
        return new DonationAlertsUser(response.data);
    }
    /**
     * Fetches a Centrifugo connection token required for establishing real-time socket connections for the
     * specified user.
     *
     * @remarks
     * This method internally uses {@link getUser} method to fetch the profile of the user, then extracts
     * the `socketConnectionToken` property.
     *
     * @param user The ID of the user for whom the token is being fetched.
     * @param rateLimiterOptions Optional rate limiter configuration to control API requests.
     *
     * @returns A string containing the user's socket connection token.
     *
     * @throws {@link HttpError} if the response status code falls outside the 200–299 range.
     * @throws {@link UnregisteredUserError} if the specified user is not registered in the authentication provider.
     * @throws {@link MissingScopeError} if the provided access token is missing the required `oauth-user-show` scope.
     *
     * @example
     * ```ts
     * const token = await apiClient.users.getSocketConnectionToken(authenticatedUserId);
     * console.log(`Socket connection token: ${token}`);
     * ```
     */
    async getSocketConnectionToken(user, rateLimiterOptions) {
        return (await this.getUser(user, rateLimiterOptions)).socketConnectionToken;
    }
};
DonationAlertsUsersApi = __decorate([
    ReadDocumentation('api')
], DonationAlertsUsersApi);
export { DonationAlertsUsersApi };