@crowdin/crowdin-api-client/out/notifications/index.d.ts

JavaScript library for Crowdin API

import { CrowdinApi } from '../core';
export declare class Notifications extends CrowdinApi {
    /**
     * @param request request body
     * @see https://developer.crowdin.com/api/v2/#operation/api.notify.post
     */
    sendNotificationToAuthenticatedUser(request: NotificationsModel.Notification): Promise<void>;
    /**
     * @param projectId project identifier
     * @param request request body
     * @see https://developer.crowdin.com/api/v2/#operation/api.projects.notify.post
     */
    sendNotificationToProjectMembers(projectId: number, request: NotificationsModel.NotificationByUsers | NotificationsModel.NotificationByRole): Promise<void>;
    /**
     * @param request request body
     * @see https://developer.crowdin.com/enterprise/api/v2/#operation/api.notify.post
     */
    sendNotificationToOrganizationMembers(request: NotificationsModel.Notification | NotificationsModel.NotificationByUsers | NotificationsModel.NotificationByRole): Promise<void>;
}
export declare namespace NotificationsModel {
    interface Notification {
        message: string;
    }
    interface NotificationByUsers extends Notification {
        userIds: number[];
    }
    interface NotificationByRole extends Notification {
        role: 'owner' | 'admin';
    }
}