import { NotifyRequest as NotifyRequest$1, NotifyResponse as NotifyResponse$1 } from './index.typings.js'; import '@wix/sdk-types'; interface Notification { /** * The id of the notification * @immutable */ id?: string; } interface NotifyRequest { /** * Notification template ID. A notification template specifies the text and recipients for notifications. * To obtain a notification template ID, create a notification template in your [app's dashboard](https://dev.wix.com/docs/build-apps/develop-your-app/app-dashboard-setup/about-the-app-dashboard). * @format GUID */ notificationTemplateId: string; /** * Each key is a placeholder name you specify when creating a notification template. * The value is an object containing the text to replace the placeholder in the notifications. */ dynamicValues?: Record; } interface DynamicValue extends DynamicValueOfTypeOneOf { /** Text to be integrated into the notification. */ text?: string; } /** @oneof */ interface DynamicValueOfTypeOneOf { /** Text to be integrated into the notification. */ text?: string; } /** * Money. * Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003. */ interface Money { /** * Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, a single (-), to indicate that the amount is negative. * @format DECIMAL_VALUE */ value?: string; /** * Currency code. Must be valid ISO 4217 currency code (e.g., USD). * @format CURRENCY */ currency?: string; /** Monetary amount. Decimal string in local format (e.g., 1 000,30). Optionally, a single (-), to indicate that the amount is negative. */ formattedValue?: string | null; } interface MapDynamicValue { /** items */ items?: Record; } interface ArrayDynamicValue { /** * items * @maxSize 100 */ items?: DynamicValue[]; } interface AttachmentDynamicValue { /** file name */ fileName?: string; /** download url */ downloadUrl?: string; } interface NotifyResponse { /** ID of the batch of notifications triggered by one request. */ notificationBatchId?: string; } interface NotifyByAppRequest { /** * notification_template_id * @format GUID */ notificationTemplateId?: string; /** * app_def_id * @format GUID */ appDefId?: string; /** dynamic_values */ dynamicValues?: Record; /** template tenant */ templateTenant?: string | null; /** overrides */ overrides?: Overrides; /** channels content */ channelsData?: ChannelsData; } interface Overrides { /** * excluded_channels * @maxSize 20 */ excludedChannels?: TemplateChannelWithLiterals[]; /** excluded_audiences */ excludedAudiences?: ExcludedAudiences; /** content overrides */ content?: ChannelsContent; } declare enum TemplateChannel { WEB_FEED = "WEB_FEED", MOBILE_FEED = "MOBILE_FEED", MOBILE_PUSH = "MOBILE_PUSH", BROWSER = "BROWSER", SMS = "SMS", EMAIL = "EMAIL", KAFKA = "KAFKA", VOICE = "VOICE" } /** @enumType */ type TemplateChannelWithLiterals = TemplateChannel | 'WEB_FEED' | 'MOBILE_FEED' | 'MOBILE_PUSH' | 'BROWSER' | 'SMS' | 'EMAIL' | 'KAFKA' | 'VOICE'; interface ExcludedAudiences { /** * audience_key * @maxSize 20 */ audienceKey?: string[]; } interface ChannelsContent { /** mobile push override */ mobileContent?: MobileContent; } interface MobileContent { /** title override of mobile push content */ title?: string; /** body override of mobile push content */ body?: string; } interface ChannelsData { /** email data */ emailData?: EmailData; } interface EmailData { /** shoutout action config */ shoutoutActionConfig?: Record | null; } interface NotifyByAppResponse { /** notification_batch_id */ notificationBatchId?: string; } interface ResolveRequest { /** * template id * @format GUID */ notificationTemplateId?: string; /** values */ dynamicValues?: Record; } interface ResolveResponse { } type __PublicMethodMetaInfo = { getUrl: (context: any) => string; httpMethod: K; path: string; pathParams: M; __requestType: T; __originalRequestType: S; __responseType: Q; __originalResponseType: R; }; declare function notify(): __PublicMethodMetaInfo<'POST', {}, NotifyRequest$1, NotifyRequest, NotifyResponse$1, NotifyResponse>; export { type ArrayDynamicValue as ArrayDynamicValueOriginal, type AttachmentDynamicValue as AttachmentDynamicValueOriginal, type ChannelsContent as ChannelsContentOriginal, type ChannelsData as ChannelsDataOriginal, type DynamicValueOfTypeOneOf as DynamicValueOfTypeOneOfOriginal, type DynamicValue as DynamicValueOriginal, type EmailData as EmailDataOriginal, type ExcludedAudiences as ExcludedAudiencesOriginal, type MapDynamicValue as MapDynamicValueOriginal, type MobileContent as MobileContentOriginal, type Money as MoneyOriginal, type Notification as NotificationOriginal, type NotifyByAppRequest as NotifyByAppRequestOriginal, type NotifyByAppResponse as NotifyByAppResponseOriginal, type NotifyRequest as NotifyRequestOriginal, type NotifyResponse as NotifyResponseOriginal, type Overrides as OverridesOriginal, type ResolveRequest as ResolveRequestOriginal, type ResolveResponse as ResolveResponseOriginal, TemplateChannel as TemplateChannelOriginal, type TemplateChannelWithLiterals as TemplateChannelWithLiteralsOriginal, type __PublicMethodMetaInfo, notify };