@azure/notification-hubs 1.0.0-beta.1

package/types/src/models/notificationBuilder.d.ts

@@ -0,0 +1,546 @@
+import { AdmNotification, AppleNotification, BaiduNotification, FirebaseLegacyNotification, WindowsNotification } from "./notification.js";
+/**
+ * Represents what is in the APNs alert body.
+ */
+export interface AppleAlert {
+    /**
+     * The title of the notification. Apple Watch displays this string in the short look notification
+     * interface. Specify a string that’s quickly understood by the user.
+     */
+    title?: string;
+    /**
+     * Additional information that explains the purpose of the notification.
+     */
+    subtitle?: string;
+    /**
+     * The content of the alert message.
+     */
+    body?: string;
+    /**
+     * The name of the launch image file to display. If the user chooses to launch your app,
+     * the contents of the specified image or storyboard file are displayed instead of your app’s normal launch image.
+     */
+    launchImage?: string;
+    /**
+     * The key for a localized title string. Specify this key instead of the title key to retrieve
+     * the title from your app’s Localizable.strings files. The value must contain the name of a key in your strings file.
+     */
+    titleLocKey?: string;
+    /**
+     * An array of strings containing replacement values for variables in your title string.
+     * Each %\@ character in the string specified by the title-loc-key is replaced by a value
+     * from this array. The first item in the array replaces the first instance
+     * of the %\@ character in the string, the second item replaces the second instance, and so on.
+     */
+    titleLocArgs?: string[];
+    /**
+     * The key for a localized subtitle string. Use this key, instead of the subtitle key, to
+     * retrieve the subtitle from your app’s Localizable.strings file.
+     * The value must contain the name of a key in your strings file.
+     */
+    subtitleLocKey?: string;
+    /**
+     * An array of strings containing replacement values for variables in your title string.
+     * Each %\@ character in the string specified by subtitle-loc-key is replaced by a value
+     * from this array. The first item in the array replaces the first instance of the
+     * %\@ character in the string, the second item replaces the second instance, and so on.
+     */
+    subtitleLocArgs?: string[];
+    /**
+     * The key for a localized message string. Use this key, instead of the body key, to
+     * retrieve the message text from your app’s Localizable.strings file. The value must contain
+     * the name of a key in your strings file.
+     */
+    locKey?: string;
+    /**
+     * An array of strings containing replacement values for variables in your message text.
+     * Each %\@ character in the string specified by loc-key is replaced by a value from
+     * this array. The first item in the array replaces the first instance of the %\@ character
+     * in the string, the second item replaces the second instance, and so on.
+     */
+    locArgs?: string[];
+}
+/**
+ * Represents an APNs critical sound
+ */
+export interface AppleCriticalSound {
+    /**
+     * The critical alert flag. Set to 1 to enable the critical alert.
+     */
+    critical: number;
+    /**
+     * The name of a sound file in your app’s main bundle or in the Library/Sounds folder
+     * of your app’s container directory. Specify the string “default” to play the system sound.
+     */
+    name: string;
+    /**
+     * The volume for the critical alert’s sound. Set this to a value between 0 (silent) and 1 (full volume).
+     */
+    volume: number;
+}
+/**
+ * Represents a native APNs message.
+ */
+export interface AppleNativeMessage extends Record<string, any> {
+    /**
+     * The information for displaying an alert.
+     */
+    alert?: string | AppleAlert;
+    /**
+     * The number to display in a badge on your app’s icon.
+     */
+    badge?: number;
+    /**
+     * The name of a sound file in your app’s main bundle or in the Library/Sounds
+     * folder of your app’s container directory. Specify the string “default” to
+     * play the system sound. Use this key for regular notifications.
+     * For critical alerts, use the sound dictionary instead.
+     */
+    sound?: string | AppleCriticalSound;
+    /**
+     * An app-specific identifier for grouping related notifications.
+     */
+    threadId?: string;
+    /**
+     * The notification’s type.
+     */
+    category?: string;
+    /**
+     * The background notification flag. To perform a silent background update,
+     * specify the value 1 and don’t include the alert, badge, or sound keys in your payload.
+     */
+    contentAvailable?: number;
+    /**
+     * The notification service app extension flag. If the value is 1, the system passes
+     * the notification to your notification service app extension before delivery.
+     */
+    mutableContent?: number;
+    /**
+     * The identifier of the window brought forward.
+     */
+    targetContentId?: string;
+    /**
+     * The importance and delivery timing of a notification.
+     */
+    interruptionLevel?: "passive" | "active" | "time-sensitive" | "critical";
+    /**
+     * The relevance score, a number between 0 and 1, that the system uses to sort the
+     * notifications from your app. The highest score gets featured in the notification summary.
+     */
+    relevanceScore?: number;
+    /**
+     * The criteria the system evaluates to determine if it displays the notification in the current Focus.
+     */
+    filterCriteria?: string;
+}
+/**
+ * Creates an APNs native message to send to Notification Hubs.
+ * @param nativeMessage - The Apple native message properties to set.
+ * @param additionalProperties - Additional properties for Apple messages.
+ * @returns An AppleNotification to send to Notification Hubs.
+ */
+export declare function buildAppleNativeMessage(nativeMessage: AppleNativeMessage, additionalProperties?: Record<string, any>): AppleNotification;
+/**
+ * Represents the targets, options, and payload for HTTP JSON messages for the Firebase Legacy HTTP interface.
+ */
+export interface FirebaseLegacyNativeMessage {
+    /**
+     * The recipient of a message.
+     */
+    to?: string;
+    /**
+     * The recipient of a multicast message, a message sent to more than one registration token.
+     */
+    registrationIds?: string[];
+    /**
+     * A logical expression of conditions that determine the message target.
+     */
+    condition?: string;
+    /**
+     * Used to identify a group of messages.
+     */
+    collapseKey?: string;
+    /**
+     * The priority of the message.
+     */
+    priority?: "normal" | "high";
+    /**
+     * The background notification flag. To perform a silent background update,
+     * specify the value 1 and don’t include the alert, badge, or sound keys in your payload.
+     */
+    contentAvailable?: boolean;
+    /**
+     * The notification service app extension flag. If the value is 1, the system passes
+     * the notification to your notification service app extension before delivery.
+     */
+    mutableContent?: number;
+    /**
+     * Specifies how long (in seconds) the message should be kept in FCM storage if the device is offline
+     */
+    timeToLive?: number;
+    /**
+     * The package name of the application where the registration tokens must match in order to receive the message.
+     */
+    restrictedPackageName?: string;
+    /**
+     * When set to true, allows developers to test a request without actually sending a message.
+     */
+    dryRun?: boolean;
+    /**
+     * Custom key-value pairs of the message's payload.
+     */
+    data?: Record<string, any>;
+    /**
+     * The predefined, user-visible key-value pairs of the notification payload.
+     */
+    notification?: FirebaseLegacyAppleNativePayload | FirebaseLegacyAndroidNativePayload | FirebaseLegacyWebNativePayload;
+}
+/**
+ * Represents an APNs native payload for the Firebase Legacy HTTP interface.
+ */
+export interface FirebaseLegacyAppleNativePayload {
+    /**
+     * The notification's title.
+     */
+    title?: string;
+    /**
+     * The notification's body text.
+     */
+    body?: string;
+    /**
+     * The sound to play when the device receives the notification.
+     */
+    sound?: string;
+    /**
+     * The value of the badge on the home screen app icon.
+     */
+    badge?: string;
+    /**
+     * The action associated with a user click on the notification which corresponds to the APNs category.
+     */
+    clickAction?: string;
+    /**
+     * The notification's subtitle.
+     */
+    subtitle?: string;
+    /**
+     * The key to the body string in the app's string resources to use to localize the body text to the user's current localization.
+     */
+    bodyLocKey?: string;
+    /**
+     * Variable string values to be used in place of the format specifiers in body_loc_key to use to localize the body text to the user's current localization.
+     */
+    bodyLocArgs?: string[];
+    /**
+     * The key to the title string in the app's string resources to use to localize the title text to the user's current localization.
+     */
+    titleLocKey?: string;
+    /**
+     * Variable string values to be used in place of the format specifiers in title_loc_key to use to localize the title text to the user's current localization.
+     */
+    titleLocArgs?: string[];
+}
+/**
+ * Represents an Android native payload for the Firebase Legacy HTTP interface.
+ */
+export interface FirebaseLegacyAndroidNativePayload {
+    /**
+     * The notification's title.
+     */
+    title?: string;
+    /**
+     * The notification's body text.
+     */
+    body?: string;
+    /**
+     * The notification's channel ID.
+     */
+    androidChannelId?: string;
+    /**
+     * The notification's icon.
+     */
+    icon?: string;
+    /**
+     * The sound to play when the device receives the notification.
+     */
+    sound?: string;
+    /**
+     * Identifier used to replace existing notifications in the notification drawer.
+     */
+    tag?: string;
+    /**
+     * The notification's icon color, expressed in #rrggbb format.
+     */
+    color?: string;
+    /**
+     * The action associated with a user click on the notification.
+     */
+    clickAction?: string;
+    /**
+     * The key to the body string in the app's string resources to use to localize the body text to the user's current localization.
+     */
+    bodyLocKey?: string;
+    /**
+     * Variable string values to be used in place of the format specifiers in body_loc_key to use to localize the body text to the user's current localization.
+     */
+    bodyLocArgs?: string[];
+    /**
+     * The key to the title string in the app's string resources to use to localize the title text to the user's current localization.
+     */
+    titleLocKey?: string;
+    /**
+     * Variable string values to be used in place of the format specifiers in title_loc_key to use to localize the title text to the user's current localization.
+     */
+    titleLocArgs?: string[];
+}
+/**
+ * Represents an Web Push native payload for the Firebase Legacy HTTP interface.
+ */
+export interface FirebaseLegacyWebNativePayload {
+    /**
+     * The notification's title.
+     */
+    title?: string;
+    /**
+     * The notification's body text.
+     */
+    body?: string;
+    /**
+     * The URL to use for the notification's icon.
+     */
+    icon?: string;
+    /**
+     * The action associated with a user click on the notification.
+     */
+    clickAction?: string;
+}
+/**
+ * Creates a FirebaseLegacyNotification from a native Firebase payload.
+ * @param nativeMessage - The native message payload to send to Notification Hubs.
+ * @returns The FirebaseLegacyNotification to send to Notification Hubs.
+ */
+export declare function buildFirebaseLegacyNativeMessage(nativeMessage: FirebaseLegacyNativeMessage): FirebaseLegacyNotification;
+/**
+ * Describes ADM notification messages.
+ */
+export interface AdmNativeNotification {
+    /**
+     * The notification's title.
+     */
+    title?: string;
+    /**
+     * The notification's body text.
+     */
+    body?: string;
+    /**
+     * The notification's icon.
+     */
+    icon?: string;
+    /**
+     * The notification's icon color, expressed in #rrggbb format.
+     */
+    color?: string;
+    /**
+     * The sound to play when the device receives the notification. Supports "default" or the filename of a sound resource bundled in the app.
+     */
+    sound?: string;
+    /**
+     * Identifier used to replace existing notifications in the notification drawer.
+     */
+    tag?: string;
+    /**
+     * The action associated with a user click on the notification.
+     */
+    clickAction?: string;
+    /**
+     * The key to the body string in the app's string resources to use to localize the body text to the user's current localization.
+     */
+    bodyLocKey?: string;
+    /**
+     * Variable string values to be used in place of the format specifiers in body_loc_key to use to localize the body text to the user's current localization.
+     */
+    bodyLocArgs?: string[];
+    /**
+     * The key to the title string in the app's string resources to use to localize the title text to the user's current localization.
+     */
+    titleLocKey?: string;
+    /**
+     * Variable string values to be used in place of the format specifiers in title_loc_key to use to localize the title text to the user's current localization.
+     */
+    titleLocArgs?: string[];
+    /**
+     * The notification's channel id.
+     */
+    channelId?: string;
+    /**
+     * Sets the "ticker" text, which is sent to accessibility services.
+     */
+    ticker?: string;
+    /**
+     * When set to false or unset, the notification is automatically dismissed when the user clicks it in the panel.
+     */
+    sticky?: boolean;
+    /**
+     * Set the time that the event in the notification occurred. Must be a timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
+     */
+    eventTime?: string;
+    /**
+     * Set whether or not this notification is relevant only to the current device.
+     */
+    localOnly?: boolean;
+    /**
+     * Set the relative priority for this notification.
+     */
+    notificationPriority?: number;
+    /**
+     * If set to true, use the Android framework's default sound for the notification.
+     */
+    defaultSound?: boolean;
+    /**
+     * Set the Notification.visibility of the notification.
+     */
+    visibility?: number;
+    /**
+     * Sets the number of items this notification represents.
+     */
+    notificationCount?: number;
+    /**
+     * Contains the URL of an image that is going to be displayed in a notification.
+     */
+    image?: string;
+}
+/**
+ * Represents a native ADM notification message payload.
+ */
+export interface AdmNativeMessage {
+    /**
+     * The notification payload to send with the message.
+     */
+    notification?: AdmNativeNotification;
+    /**
+     * The payload data to send with the message.
+     */
+    data?: Record<string, string>;
+    /**
+     * The priority of the msssage.
+     */
+    priority?: "normal" | "high";
+    /**
+     * This is an arbitrary string used to indicate that multiple messages are logically the same
+     * and that ADM is allowed to drop previously enqueued messages in favor of this new one.
+     */
+    consolidationKey?: string;
+    /**
+     * The number of seconds that ADM should retain the message if the device is offline.
+     */
+    expiresAfter?: number;
+    /**
+     * This is a base-64-encoded MD5 checksum of the data parameter.
+     */
+    md5?: string;
+}
+/**
+ * Creates a AdmNotification from a native ADM payload.
+ * @param nativeMessage - The native message payload to send to Notification Hubs.
+ * @returns The AdmNotification to send to Notification Hubs.
+ */
+export declare function buildAdmNativeMessage(nativeMessage: AdmNativeMessage): AdmNotification;
+/**
+ * Represents the Baidu Apple native payload.
+ */
+export interface BaiduAppleNativePayload {
+    /**
+     * The alert string.
+     */
+    alert?: string;
+    /**
+     * The APNs sound to play.
+     */
+    sound?: string;
+    /**
+     * The APNs badge count.
+     */
+    badge?: number;
+}
+/**
+ * Baidu Native Format:
+ * https://stackoverflow.com/questions/42591815/customize-baidu-push-json-payload
+ * http://www.tuicool.com/articles/ZnmANn
+ */
+export interface BaiduNativeMessage extends Record<string, any> {
+    /**
+     * Notification title for Android.
+     */
+    title?: string;
+    /**
+     * Baidu Notification description for Android.
+     */
+    description?: string;
+    /**
+     * Baidu Notification builder ID.
+     */
+    notificationBuilderId?: number;
+    /**
+     * Baidu Notification Android basic style.
+     */
+    notificationBasicStyle?: number;
+    /**
+     * Baidu Android open type.
+     */
+    openType?: number;
+    /**
+     * Baidu Android net support option.
+     */
+    netSupport?: number;
+    /**
+     * Baidu Android user confirm.
+     */
+    userConfirm?: number;
+    /**
+     * Baidu Android URL.
+     */
+    url?: string;
+    /**
+     * Baidu Android package content.
+     */
+    pkgContent?: string;
+    /**
+     * Baidu Android package version.
+     */
+    pkgVersion?: string;
+    /**
+     * Baidu Android custom content dictionary.
+     */
+    customContent?: Record<string, any>;
+    /**
+     * Baidu APNs support.
+     */
+    aps?: BaiduAppleNativePayload;
+}
+/**
+ * Creates a BaiduNotification from a native Baidu payload.
+ * @param nativeMessage - The native message payload to send to Notification Hubs.
+ * @param additionalProperties - Additional properties for Apple Baidu messages.
+ * @returns The BaiduNotification to send to Notification Hubs.
+ */
+export declare function buildBaiduNativeMessage(nativeMessage: BaiduNativeMessage, additionalProperties?: Record<string, any>): BaiduNotification;
+/**
+ * Represents the types of Windows Badge Glyphs
+ */
+export declare type WindowsBadgeGlyphType = "none" | "activity" | "alarm" | "alert" | "attention" | "available" | "away" | "busy" | "error" | "newMessage" | "paused" | "playing" | "unavailable";
+/**
+ * Represents the Windows Badge Message
+ */
+export interface WindowsBadgeNativeMessage {
+    /**
+     * Either a numeric value or a string value that specifies a predefined badge glyph.
+     */
+    value: WindowsBadgeGlyphType | number;
+}
+/**
+ * Builds a WindowsNotification from a Windows Badge.
+ * @param nativeMessage - The Windows Badge Message to build.
+ * @returns A WindowsNotification created with the badge information.
+ */
+export declare function buildWindowsBadgeNativeMessage(nativeMessage: WindowsBadgeNativeMessage): WindowsNotification;
+//# sourceMappingURL=notificationBuilder.d.ts.map

package/types/src/models/notificationBuilder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"notificationBuilder.d.ts","sourceRoot":"","sources":["../../../src/models/notificationBuilder.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,eAAe,EACf,iBAAiB,EACjB,iBAAiB,EACjB,0BAA0B,EAC1B,mBAAmB,EAMpB,MAAM,mBAAmB,CAAC;AAI3B;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;OAKG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IAExB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;;OAKG;IACH,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAE3B;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAC7D;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,UAAU,CAAC;IAE5B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,kBAAkB,CAAC;IAEpC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,iBAAiB,CAAC,EAAE,SAAS,GAAG,QAAQ,GAAG,gBAAgB,GAAG,UAAU,CAAC;IAEzE;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AA6BD;;;;;GAKG;AACH,wBAAgB,uBAAuB,CACrC,aAAa,EAAE,kBAAkB,EACjC,oBAAoB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GACzC,iBAAiB,CA2BnB;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAE3B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;IAE7B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAE3B;;OAEG;IACH,YAAY,CAAC,EACT,gCAAgC,GAChC,kCAAkC,GAClC,8BAA8B,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IAEvB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IAEvB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAuCD;;;;GAIG;AACH,wBAAgB,gCAAgC,CAC9C,aAAa,EAAE,2BAA2B,GACzC,0BAA0B,CAmB5B;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IAEvB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IAExB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,YAAY,CAAC,EAAE,qBAAqB,CAAC;IAErC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;IAE7B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAkCD;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,aAAa,EAAE,gBAAgB,GAAG,eAAe,CAUtF;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAmB,SAAQ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAC7D;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAEpC;;OAEG;IACH,GAAG,CAAC,EAAE,uBAAuB,CAAC;CAC/B;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CACrC,aAAa,EAAE,kBAAkB,EACjC,oBAAoB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GACzC,iBAAiB,CAoBnB;AAED;;GAEG;AACH,oBAAY,qBAAqB,GAC7B,MAAM,GACN,UAAU,GACV,OAAO,GACP,OAAO,GACP,WAAW,GACX,WAAW,GACX,MAAM,GACN,MAAM,GACN,OAAO,GACP,YAAY,GACZ,QAAQ,GACR,SAAS,GACT,aAAa,CAAC;AAElB;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,KAAK,EAAE,qBAAqB,GAAG,MAAM,CAAC;CACvC;AAED;;;;GAIG;AACH,wBAAgB,8BAA8B,CAC5C,aAAa,EAAE,yBAAyB,GACvC,mBAAmB,CAQrB"}

package/types/src/models/notificationDetails.d.ts

@@ -0,0 +1,87 @@
+/**
+ * Represents the notification outcome states.
+ */
+export declare type NotificationOutcomeState = "Enqueued" | "DetailedStateAvailable" | "Processing" | "Completed" | "Abandoned" | "Unknown" | "NoTargetFound" | "Cancelled";
+/**
+ * The per platform count per state.
+ */
+export interface NotificationOutcomeCollectionItem {
+    /**
+     * The state of the notification.
+     */
+    state: string;
+    /**
+     * The count of notifications per state.
+     */
+    count: number;
+}
+/**
+ * Represents Notification details.
+ */
+export interface NotificationDetails {
+    /**
+     * The unique notification identifier.
+     */
+    notificationId?: string;
+    /**
+     * The notification location.
+     */
+    location?: string;
+    /**
+     * The notification state.
+     */
+    state?: NotificationOutcomeState;
+    /**
+     * The enqueue time of the notification.
+     */
+    enqueueTime?: Date;
+    /**
+     * The notification send start time.
+     */
+    startTime?: Date;
+    /**
+     * The notification send end time.
+     */
+    endTime?: Date;
+    /**
+     * The notification body.
+     */
+    notificationBody?: string;
+    /**
+     * The notification tags.
+     */
+    tags?: string;
+    /**
+     * The notification platforms targeted.
+     */
+    targetPlatforms?: string;
+    /**
+     * The URL for the platform notification services errors.
+     */
+    pnsErrorDetailsUrl?: string;
+    /**
+     * APNs outcomes counts per state.
+     */
+    apnsOutcomeCounts?: NotificationOutcomeCollectionItem[];
+    /**
+     * WNS outcomes counts per state.
+     */
+    wnsOutcomeCounts?: NotificationOutcomeCollectionItem[];
+    /**
+     * FCM outcome counts per state.
+     */
+    fcmOutcomeCounts?: NotificationOutcomeCollectionItem[];
+    /**
+     * ADM outcome counts per state.
+     */
+    admOutcomeCounts?: NotificationOutcomeCollectionItem[];
+    /**
+     * Baidu outcome counts per state.
+     */
+    baiduOutcomeCounts?: NotificationOutcomeCollectionItem[];
+    /**
+     * Web Push outcome counts per state.
+     */
+    browserOutcomeCounts?: NotificationOutcomeCollectionItem[];
+}
+//# sourceMappingURL=notificationDetails.d.ts.map

package/types/src/models/notificationDetails.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"notificationDetails.d.ts","sourceRoot":"","sources":["../../../src/models/notificationDetails.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,oBAAY,wBAAwB,GAChC,UAAU,GACV,wBAAwB,GACxB,YAAY,GACZ,WAAW,GACX,WAAW,GACX,SAAS,GACT,eAAe,GACf,WAAW,CAAC;AAEhB;;GAEG;AACH,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,wBAAwB,CAAC;IAEjC;;OAEG;IACH,WAAW,CAAC,EAAE,IAAI,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,IAAI,CAAC;IAEjB;;OAEG;IACH,OAAO,CAAC,EAAE,IAAI,CAAC;IAEf;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,iBAAiB,CAAC,EAAE,iCAAiC,EAAE,CAAC;IAExD;;OAEG;IACH,gBAAgB,CAAC,EAAE,iCAAiC,EAAE,CAAC;IAEvD;;OAEG;IACH,gBAAgB,CAAC,EAAE,iCAAiC,EAAE,CAAC;IAEvD;;OAEG;IACH,gBAAgB,CAAC,EAAE,iCAAiC,EAAE,CAAC;IAEvD;;OAEG;IACH,kBAAkB,CAAC,EAAE,iCAAiC,EAAE,CAAC;IAEzD;;OAEG;IACH,oBAAoB,CAAC,EAAE,iCAAiC,EAAE,CAAC;CAC5D"}