import type { api_DeleteItemResponse } from '../models/api_DeleteItemResponse'; import type { notifications_CreateInput } from '../models/notifications_CreateInput'; import type { notifications_Notification } from '../models/notifications_Notification'; import type { notifications_NotificationsResponse } from '../models/notifications_NotificationsResponse'; import type { notifications_NotificationSuppressedResponse } from '../models/notifications_NotificationSuppressedResponse'; import type { CancelablePromise } from '../core/CancelablePromise'; export declare class NotificationsService { /** * List notifications * * Returns a paginated list of notifications for a recipient. When no * recipient filter is supplied, the authenticated user's notifications are * returned. Only unread notifications are returned unless includeRead is * true. * * @param recipientId Filter by recipient user ID. Defaults to the authenticated user when omitted. * @param recipientClientId Filter by recipient client ID. * @param recipientInternalUserId Filter by recipient internal user ID. * @param includeRead Include read notifications in the response. * @param recipientCompanyId Filter by recipient company ID. * @param limit Maximum number of records to return. * @param nextToken Pagination cursor returned by a previous request. * * @example * await assembly.listNotifications(); */ static listNotifications({ recipientId, recipientClientId, recipientInternalUserId, includeRead, recipientCompanyId, limit, nextToken, }: { /** * Filter by recipient user ID. Defaults to the authenticated user when omitted. */ recipientId?: string; /** * Filter by recipient client ID. */ recipientClientId?: string; /** * Filter by recipient internal user ID. */ recipientInternalUserId?: string; /** * Include read notifications in the response. */ includeRead?: boolean; /** * Filter by recipient company ID. */ recipientCompanyId?: string; /** * Maximum number of records to return. */ limit?: number; /** * Pagination cursor returned by a previous request. */ nextToken?: string; }): CancelablePromise; /** * Create a notification * * Creates a notification for a recipient. Requires senderId, a recipient * (recipientClientId or recipientInternalUserId), and at least one delivery * target. Notifications can only be created from a custom app. When * notificationSettingId is provided and the recipient's notification * settings disable every requested delivery target, no notification is * created and the request returns 202. * * @example * await assembly.createNotification({ requestBody: ... }); */ static createNotification({ requestBody, }: { /** * Notification to create */ requestBody: notifications_CreateInput; }): CancelablePromise; /** * Delete a notification * * Deletes a notification by ID. * * @param id Notification ID * * @example * await assembly.deleteNotification({ id: ... }); */ static deleteNotification({ id, }: { /** * Notification ID */ id: string; }): CancelablePromise; /** * Retrieve a notification * * Returns a single notification by ID. * * @param id Notification ID * * @example * await assembly.retrieveNotification({ id: ... }); */ static retrieveNotification({ id, }: { /** * Notification ID */ id: string; }): CancelablePromise; /** * Mark notification as read * * Marks a notification as read and returns the updated notification. * * @param id Notification ID * * @example * await assembly.markNotificationRead({ id: ... }); */ static markNotificationRead({ id, }: { /** * Notification ID */ id: string; }): CancelablePromise; /** * Mark notification as unread * * Marks a notification as unread and returns the updated notification. * * @param id Notification ID * * @example * await assembly.markNotificationUnread({ id: ... }); */ static markNotificationUnread({ id, }: { /** * Notification ID */ id: string; }): CancelablePromise; }