import type { notifications_AdditionalFields } from './notifications_AdditionalFields'; import type { notifications_DeliveryTargets } from './notifications_DeliveryTargets'; import type { notifications_Fields } from './notifications_Fields'; import type { notifications_MemberType } from './notifications_MemberType'; import type { notifications_Reminders } from './notifications_Reminders'; export type notifications_Notification = { additionalFields?: notifications_AdditionalFields; /** * AppID is the ID of the custom app that created the notification, when applicable. */ appId?: string; assetS3Key?: string; channelId?: string; /** * CompanyID is the company the notification is associated with, when applicable. */ companyId?: string; count?: number; createdAt?: string; creatorId?: string; data?: string; /** * DefaultListIndexPkey for the notification model is used to mark whether a notification is an inbox notification */ defaultListIndexPkey?: string; /** * DeliveryTargets describes how the notification is delivered (in-product and/or email). */ deliveryTargets?: notifications_DeliveryTargets; /** * Event is the domain event that triggered the notification. */ event?: notifications_Notification.event; /** * todo: remove fields once FE doesn't use them */ fields?: notifications_Fields; id?: string; identityId?: string; isGroup?: boolean; /** * Deprecated: use DeliveryTargets.InProduct.IsRead */ isRead?: boolean; object?: string; previousAttributes?: Record; /** * RecipientClientID is the recipient client ID, set when the recipient is a client. */ recipientClientId?: string; /** * RecipientCompanyID is the recipient company ID, set when the recipient is a client (their company). */ recipientCompanyId?: string; /** * RecipientID is the ID of the member the notification is delivered to. */ recipientId?: string; /** * RecipientInternalUserID is the recipient internal user ID, set when the recipient is an internal user. */ recipientInternalUserId?: string; recipientType?: notifications_MemberType; ref?: string; reminders?: notifications_Reminders; /** * ResourceID is the ID of the resource the notification refers to (e.g. the uploaded file or invoice). */ resourceId?: string; /** * SenderCompanyID is the sender's company ID, set when the recipient is an internal user. */ senderCompanyId?: string; /** * SenderID is the ID of the member who triggered the notification. */ senderId?: string; /** * SenderType is the kind of member that sent the notification. */ senderType?: notifications_Notification.senderType; updatedAt?: string; }; export declare namespace notifications_Notification { /** * Event is the domain event that triggered the notification. */ enum event { FILES_CREATED = "files.created", FILE_CREATED = "file.created", CONTRACT_SIGNED = "contract.signed", CONTRACT_REQUESTED = "contract.requested", FORM_RESPONSE_REQUESTED = "formResponse.requested", FORM_RESPONSE_COMPLETED = "formResponse.completed", FORM_CREATED = "form.created", INVOICE_PAID = "invoice.paid", INVOICE_REQUESTED = "invoice.requested", INVOICE_PROCESSING = "invoice.processing", INVOICE_PAYMENT_FAILED = "invoice.paymentFailed", REFUND_REQUESTED = "refund.requested", REFUND_PROCESSED = "refund.processed", REFUND_FAILED = "refund.failed", AUTO_CHARGE_PAYMENT_REQUESTED = "autoChargePayment.requested", CUSTOM_APP_ACTION = "customApp.action", INTERNAL_CHAT_MENTIONED = "internalChat.mentioned", CHANNEL_MENTIONED = "channel.mentioned" } /** * SenderType is the kind of member that sent the notification. */ enum senderType { CLIENT = "client", INTERNAL_USER = "internalUser", COMPANY = "company" } }