import { HttpResponse, RequestConfig } from '../../http/types.js'; import { BaseService } from '../base-service.js'; import { CountResponse } from './models/count-response.js'; import { Notification } from './models/notification.js'; import { NotificationCollection } from './models/notification-collection.js'; import { ArchiveAllNotificationsParams, FetchUnreadNotificationsCountParams, ListNotificationsParams, MarkAllNotificationsReadParams } from './request-params.js'; /** * Service class for NotificationsService operations. * Provides methods to interact with NotificationsService-related API endpoints. * All methods return promises and handle request/response serialization automatically. */ export declare class NotificationsService extends BaseService { /** * Lists all notifications for a user. * @param {number} [params.limit] - defines the maximum number of items to return per page (default: 50) * @param {string} [params.startingAfter] - a cursor for use in pagination, points to the last ID in previous page * @param {string} [params.endingBefore] - a cursor for use in pagination, points to the first ID in next page * @param {string} [params.status] - filter notifications by their read state, one of 'unread' | 'read' | 'archived' * @param {string} [params.category] - filter notifications by their category * @param {string} [params.topic] - filter notifications by their topic * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation. * @returns {Promise>} - OK */ listNotifications(params?: ListNotificationsParams, requestConfig?: RequestConfig): Promise>; /** * Archive all notifications. * @param {string} [params.category] - filter notifications by their category * @param {string} [params.topic] - filter notifications by their topic * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation. * @returns {Promise>} - No Content */ archiveAllNotifications(params?: ArchiveAllNotificationsParams, requestConfig?: RequestConfig): Promise>; /** * Marks all notifications as read. * @param {string} [params.category] - filter notifications by their category * @param {string} [params.topic] - filter notifications by their topic * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation. * @returns {Promise>} - No Content */ markAllNotificationsRead(params?: MarkAllNotificationsReadParams, requestConfig?: RequestConfig): Promise>; /** * Returns the count of unread notifications for a user. Supports filtering by category and topic. * @param {string} [params.category] - filter notifications by their category * @param {string} [params.topic] - filter notifications by their topic * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation. * @returns {Promise>} - OK */ fetchUnreadNotificationsCount(params?: FetchUnreadNotificationsCountParams, requestConfig?: RequestConfig): Promise>; /** * Gets a notification by ID. * @param {string} notificationId - * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation. * @returns {Promise>} - OK */ fetchNotification(notificationId: string, requestConfig?: RequestConfig): Promise>; /** * Archive a notification. * @param {string} notificationId - * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation. * @returns {Promise>} - No Content */ archiveNotification(notificationId: string, requestConfig?: RequestConfig): Promise>; /** * Marks a notification as read. * @param {string} notificationId - * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation. * @returns {Promise>} - No Content */ markNotificationRead(notificationId: string, requestConfig?: RequestConfig): Promise>; /** * Unarchives a notification. * @param {string} notificationId - * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation. * @returns {Promise>} - No Content */ unarchiveNotification(notificationId: string, requestConfig?: RequestConfig): Promise>; /** * Marks a notification as unread. * @param {string} notificationId - * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation. * @returns {Promise>} - No Content */ markNotificationUnread(notificationId: string, requestConfig?: RequestConfig): Promise>; } //# sourceMappingURL=notifications-service.d.ts.map