nestjs-yookassa/dist/webhook/interfaces/notification-event.interface.d.ts

A NestJS library for integrating with YooKassa API

import type { YookassaMetadata } from '../../common/types/metadata.type';
import { NotificationEventEnum, NotificationTypeEnum } from '../enums';
import { Payment } from '../../modules/payment/interfaces';
import { Refund } from '../../modules/refund/interfaces';
/**
 * Базовый интерфейс уведомления вебхука Юкассы.
 */
export interface BaseNotification<T> {
    /**
     * Тип уведомления.
     */
    type: NotificationTypeEnum;
    /**
     * Тип события.
     */
    event: NotificationEventEnum;
    /**
     * Объект события (платеж, возврат и т.д.).
     */
    object: T;
}
/**
 * Уведомление о платеже.
 */
export interface PaymentNotificationEvent<T extends YookassaMetadata = YookassaMetadata> extends BaseNotification<Payment<T>> {
    event: NotificationEventEnum.PAYMENT_WAITING_FOR_CAPTURE | NotificationEventEnum.PAYMENT_SUCCEEDED | NotificationEventEnum.PAYMENT_CANCELED;
}
/**
 * Уведомление о возврате.
 */
export interface RefundNotificationEvent extends BaseNotification<Refund> {
    event: NotificationEventEnum.REFUND_SUCCEEDED;
}
/**
 * Объединенный тип события вебхука.
 */
export type YookassaNotification<Metadata extends YookassaMetadata = YookassaMetadata> = PaymentNotificationEvent<Metadata> | RefundNotificationEvent;