modrinthjs/dist/src/services/NotificationsService.d.ts

A type safe Modrinth implementation.

import type { Notification } from '../models/Notification';
import type { CancelablePromise } from '../core/CancelablePromise';
export declare class NotificationsService {
    /**
     * Get user's notifications
     * @param idUsername The ID or username of the user
     * @returns Notification Expected response to a valid request
     * @throws ApiError
     */
    static getUserNotifications(idUsername: string): CancelablePromise<Array<Notification>>;
    /**
     * Get notification from ID
     * @param id The ID of the notification
     * @returns Notification Expected response to a valid request
     * @throws ApiError
     */
    static getNotification(id: string): CancelablePromise<Notification>;
    /**
     * Mark notification as read
     * @param id The ID of the notification
     * @returns void
     * @throws ApiError
     */
    static readNotification(id: string): CancelablePromise<void>;
    /**
     * Delete notification
     * @param id The ID of the notification
     * @returns void
     * @throws ApiError
     */
    static deleteNotification(id: string): CancelablePromise<void>;
    /**
     * Get multiple notifications
     * @param ids The IDs of the notifications
     * @returns Notification Expected response to a valid request
     * @throws ApiError
     */
    static getNotifications(ids: string): CancelablePromise<Array<Notification>>;
    /**
     * Mark multiple notifications as read
     * @param ids The IDs of the notifications
     * @returns void
     * @throws ApiError
     */
    static readNotifications(ids: string): CancelablePromise<void>;
    /**
     * Delete multiple notifications
     * @param ids The IDs of the notifications
     * @returns void
     * @throws ApiError
     */
    static deleteNotifications(ids: string): CancelablePromise<void>;
}