@azure/notification-hubs 1.0.0-beta.6 → 1.0.0-beta.8

package/types/latest/notification-hubs.d.ts

@@ -76,27 +76,27 @@ export declare interface AdmNativeNotification {
     /**
      * The action associated with a user click on the notification.
      */
-    clickAction?: string;
+    click_action?: 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;
+    body_loc_key?: 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[];
+    body_loc_args?: 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;
+    title_loc_key?: 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[];
+    title_loc_args?: string[];
     /**
      * The notification's channel id.
      */
-    channelId?: string;
+    channel_id?: string;
     /**
      * Sets the "ticker" text, which is sent to accessibility services.
      */
@@ -108,27 +108,27 @@ export declare interface AdmNativeNotification {
     /**
      * 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;
+    event_time?: string;
     /**
      * Set whether or not this notification is relevant only to the current device.
      */
-    localOnly?: boolean;
+    local_only?: boolean;
     /**
      * Set the relative priority for this notification.
      */
-    notificationPriority?: number;
+    notification_priority?: "PRIORITY_UNSPECIFIED" | "PRIORITY_MIN" | "PRIORITY_LOW" | "PRIORITY_DEFAULT" | "PRIORITY_HIGH" | "PRIORITY_MAX";
     /**
      * If set to true, use the Android framework's default sound for the notification.
      */
-    defaultSound?: boolean;
+    default_sound?: boolean;
     /**
      * Set the Notification.visibility of the notification.
      */
-    visibility?: number;
+    visibility?: "VISIBILITY_UNSPECIFIED" | "PRIVATE" | "PUBLIC" | "SECRET";
     /**
      * Sets the number of items this notification represents.
      */
-    notificationCount?: number;
+    notification_count?: number;
     /**
      * Contains the URL of an image that is going to be displayed in a notification.
      */
@@ -146,27 +146,50 @@ export declare interface AdmNotification extends JsonNotification {
 }
 
 /**
- * Represents the description of the Amazon Device Messaging (ADM) registration.
+ * Describes an ADM Registration channel query.
  */
-export declare interface AdmRegistrationDescription extends RegistrationDescriptionCommon {
+export declare interface AdmRegistrationChannel {
     /**
-     * The Amazon Device Messaging registration identifier.
+     * The ADM Registration ID.
      */
     admRegistrationId: string;
     /**
-     * The type of the registration.
+     * The kind of the registration channel.
      */
-    type: "Adm";
+    kind: "adm";
+}
+
+/**
+ * Represents the description of the Amazon Device Messaging (ADM) registration.
+ */
+export declare interface AdmRegistrationDescription extends AdmRegistrationDescriptionCommon {
+    /**
+     * The kind of the registration.
+     */
+    kind: "Adm";
+}
+
+export declare interface AdmRegistrationDescriptionCommon extends RegistrationDescriptionCommon {
+    /**
+     * The Amazon Device Messaging registration identifier.
+     */
+    admRegistrationId: string;
 }
 
 /**
  * Represents the description of the Amazon Device Messaging (ADM) template registration.
  */
-export declare interface AdmTemplateRegistrationDescription extends Omit<AdmRegistrationDescription, "type">, TemplateRegistrationDescription {
+export declare interface AdmTemplateRegistrationDescription extends AdmTemplateRegistrationDescriptionCommon {
     /**
-     * The type of the registration.
+     * The kind of the registration.
      */
-    type: "AdmTemplate";
+    kind: "AdmTemplate";
+}
+
+/**
+ * Represents the description of the Amazon Device Messaging (ADM) template registration.
+ */
+export declare interface AdmTemplateRegistrationDescriptionCommon extends AdmRegistrationDescriptionCommon, TemplateRegistrationDescription {
 }
 
 /**
@@ -190,45 +213,45 @@ export declare interface AppleAlert {
      * 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;
+    "launch-image"?: 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;
+    "title-loc-key"?: 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[];
+    "title-loc-args"?: 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;
+    "subtitle-loc-key"?: 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[];
+    "subtitle-loc-args"?: 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;
+    "loc-key"?: 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[];
+    "loc-args"?: string[];
 }
 
 /**
@@ -282,7 +305,7 @@ export declare interface AppleNativeMessage extends Record<string, any> {
     /**
      * An app-specific identifier for grouping related notifications.
      */
-    threadId?: string;
+    "thread-id"?: string;
     /**
      * The notification’s type.
      */
@@ -291,29 +314,29 @@ export declare interface AppleNativeMessage extends Record<string, any> {
      * 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;
+    "content-available"?: 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;
+    "mutable-content"?: number;
     /**
      * The identifier of the window brought forward.
      */
-    targetContentId?: string;
+    "target-content-id"?: string;
     /**
      * The importance and delivery timing of a notification.
      */
-    interruptionLevel?: "passive" | "active" | "time-sensitive" | "critical";
+    "interruption-level"?: "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;
+    "relevance-score"?: number;
     /**
      * The criteria the system evaluates to determine if it displays the notification in the current Focus.
      */
-    filterCriteria?: string;
+    "filter-criteria"?: string;
 }
 
 /**
@@ -327,28 +350,53 @@ export declare interface AppleNotification extends JsonNotification {
 }
 
 /**
- * The priority of the Apple push notification.
+ * Describes an Apple Registration channel query.
+ */
+export declare interface AppleRegistrationChannel {
+    /**
+     * The APNs device token.
+     */
+    deviceToken: string;
+    /**
+     * The kind of the registration channel.
+     */
+    kind: "apple";
+}
+
+/**
+ * Represents the description of apple registration.
  */
-export declare type ApplePriority = "10" | "5";
+export declare interface AppleRegistrationDescription extends AppleRegistrationDescriptionCommon {
+    /**
+     * The kind of the registration.
+     */
+    kind: "Apple";
+}
 
 /**
  * Represents the description of apple registration.
  */
-export declare interface AppleRegistrationDescription extends RegistrationDescriptionCommon {
+export declare interface AppleRegistrationDescriptionCommon extends RegistrationDescriptionCommon {
     /**
      * The APNs device token.
      */
     deviceToken: string;
+}
+
+/**
+ * Represents the description of the Apple template registration.
+ */
+export declare interface AppleTemplateRegistrationDescription extends AppleTemplateRegistrationDescriptionCommon {
     /**
-     * The type of the registration.
+     * The kind of the registration.
      */
-    type: "Apple";
+    kind: "AppleTemplate";
 }
 
 /**
  * Represents the description of the Apple template registration.
  */
-export declare interface AppleTemplateRegistrationDescription extends Omit<AppleRegistrationDescription, "type">, TemplateRegistrationDescription {
+export declare interface AppleTemplateRegistrationDescriptionCommon extends AppleRegistrationDescriptionCommon, TemplateRegistrationDescription {
     /**
      * The expiry date.
      */
@@ -356,15 +404,11 @@ export declare interface AppleTemplateRegistrationDescription extends Omit<Apple
     /**
      * The notification priority.
      */
-    priority?: ApplePriority;
+    priority?: "10" | "5";
     /**
      * The APNS headers.
      */
     apnsHeaders?: Record<string, string>;
-    /**
-     * The type of the registration.
-     */
-    type: "AppleTemplate";
 }
 
 /**
@@ -412,23 +456,23 @@ export declare interface BaiduNativeMessage extends Record<string, any> {
     /**
      * Baidu Notification builder ID.
      */
-    notificationBuilderId?: number;
+    notification_builder_id?: number;
     /**
      * Baidu Notification Android basic style.
      */
-    notificationBasicStyle?: number;
+    notification_basic_style?: number;
     /**
      * Baidu Android open type.
      */
-    openType?: number;
+    open_type?: number;
     /**
      * Baidu Android net support option.
      */
-    netSupport?: number;
+    net_support?: number;
     /**
      * Baidu Android user confirm.
      */
-    userConfirm?: number;
+    user_confirm?: number;
     /**
      * Baidu Android URL.
      */
@@ -436,15 +480,15 @@ export declare interface BaiduNativeMessage extends Record<string, any> {
     /**
      * Baidu Android package content.
      */
-    pkgContent?: string;
+    pkg_content?: string;
     /**
      * Baidu Android package version.
      */
-    pkgVersion?: string;
+    pkg_version?: string;
     /**
      * Baidu Android custom content dictionary.
      */
-    customContent?: Record<string, any>;
+    custom_content?: Record<string, any>;
     /**
      * Baidu APNs support.
      */
@@ -461,10 +505,35 @@ export declare interface BaiduNotification extends JsonNotification {
     platform: "baidu";
 }
 
+/**
+ * Describes an Baidu Registration channel query.
+ */
+export declare interface BaiduRegistrationChannel {
+    /**
+     * The Baidu Channel ID.
+     */
+    baiduChannelId: string;
+    /**
+     * The Baidu User ID.
+     */
+    baiduUserId: string;
+    /**
+     * The kind of the registration channel.
+     */
+    kind: "baidu";
+}
+
 /**
  * Represents a Baidu registration description.
  */
-export declare interface BaiduRegistrationDescription extends RegistrationDescriptionCommon {
+export declare interface BaiduRegistrationDescription extends BaiduRegistrationDescriptionCommon {
+    /**
+     * The kind of the registration.
+     */
+    kind: "Baidu";
+}
+
+export declare interface BaiduRegistrationDescriptionCommon extends RegistrationDescriptionCommon {
     /**
      * The Baidu user identifier.
      */
@@ -473,34 +542,42 @@ export declare interface BaiduRegistrationDescription extends RegistrationDescri
      * The Baidu channel identifier.
      */
     baiduChannelId: string;
+}
+
+/**
+ * Represents a Baidu template registration description.
+ */
+export declare interface BaiduTemplateRegistrationDescription extends BaiduTemplateRegistrationDescriptionCommon {
     /**
-     * The type of the registration.
+     * The kind of the registration.
      */
-    type: "Baidu";
+    kind: "BaiduTemplate";
 }
 
 /**
  * Represents a Baidu template registration description.
  */
-export declare interface BaiduTemplateRegistrationDescription extends Omit<BaiduRegistrationDescription, "type">, TemplateRegistrationDescription {
+export declare interface BaiduTemplateRegistrationDescriptionCommon extends BaiduRegistrationDescriptionCommon, TemplateRegistrationDescription {
+}
+
+/**
+ * Represents a Browser/Web Push based installation.
+ */
+export declare interface BrowserInstallation extends BrowserInstallationCommon {
     /**
-     * The type of the registration.
+     * The platform for the installation.
      */
-    type: "BaiduTemplate";
+    platform: "browser";
 }
 
 /**
  * Represents a Browser/Web Push based installation.
  */
-export declare interface BrowserInstallation extends InstallationCommon {
+export declare interface BrowserInstallationCommon extends InstallationCommon {
     /**
      * The push channel for the Web Push API.
      */
     pushChannel: BrowserPushChannel;
-    /**
-     * The platform for the installation.
-     */
-    platform: "browser";
 }
 
 /**
@@ -532,269 +609,309 @@ export declare interface BrowserPushChannel {
 }
 
 /**
- * Represents a Browser Push registration description.
+ * Describes an Browser Registration channel query.
  */
-export declare interface BrowserRegistrationDescription extends RegistrationDescriptionCommon {
+export declare interface BrowserRegistrationChannel {
     /**
-     * The Browser push endpoint.
+     * The Web Push endpoint URL.
      */
     endpoint: string;
     /**
-     * The Browser push P256DH.
+     * The Web Push subscription P256DH.
      */
     p256dh: string;
     /**
-     * The Browser push auth secret.
+     * The Web Push subscription auth secret.
      */
     auth: string;
     /**
-     * The type of the registration.
+     * The kind of the registration channel.
      */
-    type: "Browser";
+    kind: "browser";
 }
 
 /**
- * Represents a Browser Push remplate registration description.
+ * Represents a Browser Push registration description.
  */
-export declare interface BrowserTemplateRegistrationDescription extends Omit<BrowserRegistrationDescription, "type">, TemplateRegistrationDescription {
+export declare interface BrowserRegistrationDescription extends BrowserRegistrationDescriptionCommon {
     /**
-     * The type of the registration.
+     * The kind of the registration.
      */
-    type: "BrowserTemplate";
+    kind: "Browser";
 }
 
 /**
- * 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;
-
-/**
- * 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;
-
-/**
- * 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.
+ * Represents a Browser Push registration description.
  */
-export declare function buildBaiduNativeMessage(nativeMessage: BaiduNativeMessage, additionalProperties?: Record<string, any>): BaiduNotification;
+export declare interface BrowserRegistrationDescriptionCommon extends RegistrationDescriptionCommon {
+    /**
+     * The Browser push endpoint.
+     */
+    endpoint: string;
+    /**
+     * The Browser push P256DH.
+     */
+    p256dh: string;
+    /**
+     * The Browser push auth secret.
+     */
+    auth: string;
+}
 
 /**
- * Creates a FcmLegacyNotification from a native Firebase payload.
- * @param nativeMessage - The native message payload to send to Notification Hubs.
- * @returns The FcmLegacyNotification to send to Notification Hubs.
+ * Represents a Browser Push remplate registration description.
  */
-export declare function buildFirebaseLegacyNativeMessage(nativeMessage: FirebaseLegacyNativeMessage): FcmLegacyNotification;
+export declare interface BrowserTemplateRegistrationDescription extends BrowserTemplateRegistrationDescriptionCommon {
+    /**
+     * The kind of the registration.
+     */
+    kind: "BrowserTemplate";
+}
 
 /**
- * Builds a WindowsNotification from a Windows Badge.
- * @param nativeMessage - The Windows Badge Message to build.
- * @returns A WindowsNotification created with the badge information.
+ * Represents a Browser Push remplate registration description.
  */
-export declare function buildWindowsBadgeNativeMessage(nativeMessage: WindowsBadgeNativeMessage): WindowsNotification;
+export declare interface BrowserTemplateRegistrationDescriptionCommon extends BrowserRegistrationDescriptionCommon, TemplateRegistrationDescription {
+}
 
 /**
  * Creates an Amazon Device Messaging (ADM) based installation.
  * @param installation - A partial installation used to create the ADM installation.
  * @returns The newly created ADM installation.
  */
-export declare function createAdmInstallation(installation: Omit<AdmInstallation, "platform">): AdmInstallation;
+export declare function createAdmInstallation(installation: DeviceTokenInstallation): AdmInstallation;
 
 /**
  * Creates a notification to send to an Amazon Device Messaging device.
  * @param notification - A partial message used to create a message for Amazon Device Messaging.
  * @returns A newly created Amazon Device Messaging.
  */
-export declare function createAdmNotification(notification: Omit<AdmNotification, "platform" | "contentType">): AdmNotification;
+export declare function createAdmNotification(notification: NotificationCommon): AdmNotification;
+
+/**
+ * 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 createAdmNotificationBody(nativeMessage: AdmNativeMessage): string;
 
 /**
  * Creates an ADM registration description.
  * @param description - A partial ADM registration description.
  * @returns A created ADM registration description.
  */
-export declare function createAdmRegistrationDescription(description: Omit<AdmRegistrationDescription, "type">): AdmRegistrationDescription;
+export declare function createAdmRegistrationDescription(description: AdmRegistrationDescriptionCommon): AdmRegistrationDescription;
 
 /**
  * Creates an ADM template registration description.
  * @param description - A partial ADM template registration description.
  * @returns A created ADM template registration description.
  */
-export declare function createAdmTemplateRegistrationDescription(description: Omit<AdmTemplateRegistrationDescription, "type">): AdmTemplateRegistrationDescription;
+export declare function createAdmTemplateRegistrationDescription(description: AdmTemplateRegistrationDescriptionCommon): AdmTemplateRegistrationDescription;
 
 /**
  * Creates an Apple based installation.
  * @param installation - A partial installation used to create the Apple installation.
  * @returns The newly created Apple installation.
  */
-export declare function createAppleInstallation(installation: Omit<AppleInstallation, "platform">): AppleInstallation;
+export declare function createAppleInstallation(installation: DeviceTokenInstallation): AppleInstallation;
 
 /**
  * Creates a notification to send to an Apple device.
  * @param notification - A partial message used to create a message for Apple.
  * @returns A newly created Apple.
  */
-export declare function createAppleNotification(notification: Omit<AppleNotification, "platform" | "contentType">): AppleNotification;
+export declare function createAppleNotification(notification: NotificationCommon): AppleNotification;
+
+/**
+ * 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 createAppleNotificationBody(nativeMessage: AppleNativeMessage): string;
 
 /**
  * Creates an Apple registration description.
  * @param description - A partial Apple registration description.
  * @returns A created Apple registration description.
  */
-export declare function createAppleRegistrationDescription(description: Omit<AppleRegistrationDescription, "type">): AppleRegistrationDescription;
+export declare function createAppleRegistrationDescription(description: AppleRegistrationDescriptionCommon): AppleRegistrationDescription;
 
 /**
  * Creates an Apple template registration description.
  * @param description - A partial Apple template registration description.
  * @returns A created Apple template registration description.
  */
-export declare function createAppleTemplateRegistrationDescription(description: Omit<AppleTemplateRegistrationDescription, "type">): AppleTemplateRegistrationDescription;
+export declare function createAppleTemplateRegistrationDescription(description: AppleTemplateRegistrationDescriptionCommon): AppleTemplateRegistrationDescription;
 
 /**
  * Creates a Baidu based installation.
  * @param installation - A partial installation used to create the Baidu installation.
  * @returns The newly created Baidu installation.
  */
-export declare function createBaiduInstallation(installation: Omit<BaiduInstallation, "platform">): BaiduInstallation;
+export declare function createBaiduInstallation(installation: DeviceTokenInstallation): BaiduInstallation;
 
 /**
  * Creates a notification to send to a Baidu registered device.
  * @param notification - A partial message used to create a message for Baidu.
  * @returns A newly created Baidu.
  */
-export declare function createBaiduNotification(notification: Omit<BaiduNotification, "platform" | "contentType">): BaiduNotification;
+export declare function createBaiduNotification(notification: NotificationCommon): BaiduNotification;
+
+/**
+ * Creates a BaiduNotification from a native Baidu payload.
+ * @param nativeMessage - The native message payload to send to Notification Hubs.
+ * @returns The JSON body to send to Notification Hubs.
+ */
+export declare function createBaiduNotificationBody(nativeMessage: BaiduNativeMessage): string;
 
 /**
  * Creates a Baidu registration description.
  * @param description - A partial Baidu registration description.
  * @returns A created Baidu registration description.
  */
-export declare function createBaiduRegistrationDescription(description: Omit<BaiduRegistrationDescription, "type">): BaiduRegistrationDescription;
+export declare function createBaiduRegistrationDescription(description: BaiduRegistrationDescriptionCommon): BaiduRegistrationDescription;
 
 /**
  * Creates a Baidu template registration description.
  * @param description - A partial Baidu template registration description.
  * @returns A created Baidu template registration description.
  */
-export declare function createBaiduTemplateRegistrationDescription(description: Omit<BaiduTemplateRegistrationDescription, "type">): BaiduTemplateRegistrationDescription;
+export declare function createBaiduTemplateRegistrationDescription(description: BaiduTemplateRegistrationDescriptionCommon): BaiduTemplateRegistrationDescription;
 
 /**
  * Creates a Web Push based installation.
  * @param installation - A partial installation used to create the Web Push installation.
  * @returns The newly created Web Push installation.
  */
-export declare function createBrowserInstallation(installation: Omit<BrowserInstallation, "platform">): BrowserInstallation;
+export declare function createBrowserInstallation(installation: BrowserInstallationCommon): BrowserInstallation;
 
 /**
  * Creates a notification to send to a browser.
  * @param notification - A partial message used to create a message for a browser.
  * @returns A newly created Web Push browser.
  */
-export declare function createBrowserNotification(notification: Omit<BrowserNotification, "platform" | "contentType">): BrowserNotification;
+export declare function createBrowserNotification(notification: NotificationCommon): BrowserNotification;
 
 /**
  * Creates a Web Push registration description.
  * @param description - A partial Web Push registration description.
  * @returns A created Web Push registration description.
  */
-export declare function createBrowserRegistrationDescription(description: Omit<BrowserRegistrationDescription, "type">): BrowserRegistrationDescription;
+export declare function createBrowserRegistrationDescription(description: BrowserRegistrationDescriptionCommon): BrowserRegistrationDescription;
 
 /**
  * Creates a Web Push registration description.
  * @param description - A partial Web Push template registration description.
  * @returns A created Web Push template registration description.
  */
-export declare function createBrowserTemplateRegistrationDescription(description: Omit<BrowserTemplateRegistrationDescription, "type">): BrowserTemplateRegistrationDescription;
+export declare function createBrowserTemplateRegistrationDescription(description: BrowserTemplateRegistrationDescriptionCommon): BrowserTemplateRegistrationDescription;
 
 /**
  * Creates a Firebase legacy HTTP based installation.
  * @param installation - A partial installation used to create the Firebase Legacy HTTP installation.
  * @returns The newly created Baidu installation.
  */
-export declare function createFcmLegacyInstallation(installation: Omit<FcmLegacyInstallation, "platform">): FcmLegacyInstallation;
+export declare function createFcmLegacyInstallation(installation: DeviceTokenInstallation): FcmLegacyInstallation;
 
 /**
  * Creates a notification to send to Firebase.
  * @param notification - A partial message used to create a message for Firebase.
  * @returns A newly created Firebase.
  */
-export declare function createFcmLegacyNotification(notification: Omit<FcmLegacyNotification, "platform" | "contentType">): FcmLegacyNotification;
+export declare function createFcmLegacyNotification(notification: NotificationCommon): FcmLegacyNotification;
 
 /**
  * Creates a Firebase Legacy registration description.
  * @param description - A partial GCM registration description.
  * @returns A created GCM registration description.
  */
-export declare function createFcmLegacyRegistrationDescription(description: Omit<GcmRegistrationDescription, "type">): GcmRegistrationDescription;
+export declare function createFcmLegacyRegistrationDescription(description: GcmRegistrationDescriptionCommon): GcmRegistrationDescription;
 
 /**
  * Creates a GCM template registration description.
  * @param description - A partial GCM template registration description.
  * @returns A created GCM template registration description.
  */
-export declare function createFcmLegacyTemplateRegistrationDescription(description: Omit<GcmTemplateRegistrationDescription, "type">): GcmTemplateRegistrationDescription;
+export declare function createFcmLegacyTemplateRegistrationDescription(description: GcmTemplateRegistrationDescriptionCommon): GcmTemplateRegistrationDescription;
+
+/**
+ * Creates a FcmLegacyNotification from a native Firebase payload.
+ * @param nativeMessage - The native message payload to send to Notification Hubs.
+ * @returns The JSON body to send to Notification Hubs.
+ */
+export declare function createFirebaseLegacyNotificationBody(nativeMessage: FirebaseLegacyNativeMessage): string;
+
+/**
+ * Creates a tag expression from a list of tags as a || expression.
+ * @param tags - The tags to create the || expression
+ * @returns The tag expression made from the array of strings into an || expression.
+ */
+export declare function createTagExpression(tags: string[]): string;
 
 /**
  * Creates a notification to send to Firebase.
  * @param notification - A partial message used to create a message for Firebase.
  * @returns A newly created Firebase.
  */
-export declare function createTemplateNotification(notification: Omit<TemplateNotification, "platform" | "contentType">): TemplateNotification;
+export declare function createTemplateNotification(notification: NotificationCommon): TemplateNotification;
 
 /**
  * Creates a badge message to send to WNS.
  * @param notification - A partial message used to create a badge message for WNS.
  * @returns A newly created WNS badge.
  */
-export declare function createWindowsBadgeNotification(notification: Omit<WindowsNotification, "platform" | "contentType">): WindowsNotification;
+export declare function createWindowsBadgeNotification(notification: NotificationCommon): WindowsNotification;
+
+/**
+ * Builds a WindowsNotification from a Windows Badge.
+ * @param nativeMessage - The Windows Badge Message to build.
+ * @returns The WNS XML created with the badge information.
+ */
+export declare function createWindowsBadgeNotificationBody(nativeMessage: WindowsBadgeNativeMessage): string;
 
 /**
  * Creates a Windows Notification Services (WNS) based installation.
  * @param installation - A partial installation used to create the WNS installation.
  * @returns The newly created WNS installation.
  */
-export declare function createWindowsInstallation(installation: Omit<WindowsInstallation, "platform">): WindowsInstallation;
+export declare function createWindowsInstallation(installation: DeviceTokenInstallation): WindowsInstallation;
 
 /**
  * Creates a notification to send to WNS in wns/raw format..
  * @param notification - A partial message used to create a message for WNS in XML format.
  * @returns A newly created WNS message using XML.
  */
-export declare function createWindowsRawNotification(notification: Omit<WindowsNotification, "platform" | "contentType">): WindowsNotification;
+export declare function createWindowsRawNotification(notification: NotificationCommon): WindowsNotification;
 
 /**
  * Creates a Windows registration description.
  * @param description - A partial Windows registration description.
  * @returns A created Windows registration description.
  */
-export declare function createWindowsRegistrationDescription(description: Omit<WindowsRegistrationDescription, "type">): WindowsRegistrationDescription;
+export declare function createWindowsRegistrationDescription(description: WindowsRegistrationDescriptionCommon): WindowsRegistrationDescription;
 
 /**
  * Creates a Windows template registration description.
  * @param description - A partial Windows template registration description.
  * @returns A created Windows template registration description.
  */
-export declare function createWindowsTemplateRegistrationDescription(description: Omit<WindowsTemplateRegistrationDescription, "type">): WindowsTemplateRegistrationDescription;
+export declare function createWindowsTemplateRegistrationDescription(description: WindowsTemplateRegistrationDescriptionCommon): WindowsTemplateRegistrationDescription;
 
 /**
  * Creates a tile message to send to WNS.
  * @param notification - A partial message used to create a tile message for WNS.
  * @returns A newly created WNS tile.
  */
-export declare function createWindowsTileNotification(notification: Omit<WindowsNotification, "platform" | "contentType">): WindowsNotification;
+export declare function createWindowsTileNotification(notification: NotificationCommon): WindowsNotification;
 
 /**
  * Creates a toast message to send to WNS.
  * @param notification - A partial message used to create a toast message for WNS.
  * @returns A newly created WNS toast.
  */
-export declare function createWindowsToastNotification(notification: Omit<WindowsNotification, "platform" | "contentType">): WindowsNotification;
+export declare function createWindowsToastNotification(notification: NotificationCommon): WindowsNotification;
 
 /**
  * Represents an installation with a string based device token.
@@ -861,7 +978,7 @@ export declare interface FirebaseLegacyAndroidNativePayload {
     /**
      * The notification's channel ID.
      */
-    androidChannelId?: string;
+    android_channel_id?: string;
     /**
      * The notification's icon.
      */
@@ -881,23 +998,23 @@ export declare interface FirebaseLegacyAndroidNativePayload {
     /**
      * The action associated with a user click on the notification.
      */
-    clickAction?: string;
+    click_action?: 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;
+    body_loc_key?: 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[];
+    body_loc_args?: 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;
+    title_loc_key?: 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[];
+    title_loc_args?: string[];
 }
 
 /**
@@ -923,7 +1040,7 @@ export declare interface FirebaseLegacyAppleNativePayload {
     /**
      * The action associated with a user click on the notification which corresponds to the APNs category.
      */
-    clickAction?: string;
+    click_action?: string;
     /**
      * The notification's subtitle.
      */
@@ -931,19 +1048,19 @@ export declare interface FirebaseLegacyAppleNativePayload {
     /**
      * 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;
+    body_loc_key?: 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[];
+    body_loc_args?: 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;
+    title_loc_key?: 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[];
+    title_loc_args?: string[];
 }
 
 /**
@@ -957,7 +1074,7 @@ export declare interface FirebaseLegacyNativeMessage {
     /**
      * The recipient of a multicast message, a message sent to more than one registration token.
      */
-    registrationIds?: string[];
+    registration_ids?: string[];
     /**
      * A logical expression of conditions that determine the message target.
      */
@@ -965,7 +1082,7 @@ export declare interface FirebaseLegacyNativeMessage {
     /**
      * Used to identify a group of messages.
      */
-    collapseKey?: string;
+    collapse_key?: string;
     /**
      * The priority of the message.
      */
@@ -974,24 +1091,24 @@ export declare interface FirebaseLegacyNativeMessage {
      * 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;
+    content_available?: 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;
+    mutable_content?: number;
     /**
      * Specifies how long (in seconds) the message should be kept in FCM storage if the device is offline
      */
-    timeToLive?: number;
+    time_to_live?: number;
     /**
      * The package name of the application where the registration tokens must match in order to receive the message.
      */
-    restrictedPackageName?: string;
+    restricted_package_name?: string;
     /**
      * When set to true, allows developers to test a request without actually sending a message.
      */
-    dryRun?: boolean;
+    dry_run?: boolean;
     /**
      * Custom key-value pairs of the message's payload.
      */
@@ -1002,6 +1119,20 @@ export declare interface FirebaseLegacyNativeMessage {
     notification?: FirebaseLegacyAppleNativePayload | FirebaseLegacyAndroidNativePayload | FirebaseLegacyWebNativePayload;
 }
 
+/**
+ * Describes an Firebase Legacy Registration channel query.
+ */
+export declare interface FirebaseLegacyRegistrationChannel {
+    /**
+     * The FCM Legacy registration ID.
+     */
+    gcmRegistrationId: string;
+    /**
+     * The kind of the registration channel.
+     */
+    kind: "gcm";
+}
+
 /**
  * Represents an Web Push native payload for the Firebase Legacy HTTP interface.
  */
@@ -1021,31 +1152,43 @@ export declare interface FirebaseLegacyWebNativePayload {
     /**
      * The action associated with a user click on the notification.
      */
-    clickAction?: string;
+    click_action?: string;
 }
 
 /**
  * Represents Notification Hub registration description for Google Cloud Messaging.
  */
-export declare interface GcmRegistrationDescription extends RegistrationDescriptionCommon {
+export declare interface GcmRegistrationDescription extends GcmRegistrationDescriptionCommon {
     /**
-     * Registration id obtained from the Google Cloud Messaging service.
+     * The kind of the registration.
      */
-    gcmRegistrationId: string;
+    kind: "Gcm";
+}
+
+/**
+ * Represents Notification Hub registration description for Google Cloud Messaging.
+ */
+export declare interface GcmRegistrationDescriptionCommon extends RegistrationDescriptionCommon {
     /**
-     * The type of the registration.
+     * Registration id obtained from the Google Cloud Messaging service.
      */
-    type: "Gcm";
+    gcmRegistrationId: string;
 }
 
 /**
  * Represents Notification Hub template registration description for Firebase Legacy Cloud Messaging.
  */
-export declare interface GcmTemplateRegistrationDescription extends Omit<GcmRegistrationDescription, "type">, TemplateRegistrationDescription {
+export declare interface GcmTemplateRegistrationDescription extends GcmTemplateRegistrationDescriptionCommon {
     /**
-     * The type of the registration.
+     * The kind of the registration.
      */
-    type: "GcmTemplate";
+    kind: "GcmTemplate";
+}
+
+/**
+ * Represents Notification Hub template registration description for Firebase Legacy Cloud Messaging.
+ */
+export declare interface GcmTemplateRegistrationDescriptionCommon extends GcmRegistrationDescriptionCommon, TemplateRegistrationDescription {
 }
 
 /**
@@ -1073,10 +1216,6 @@ export declare interface InstallationCommon {
      * The last update date of the installation.
      */
     readonly lastUpdate?: string;
-    /**
-     * The platform for the installation.
-     */
-    platform: "apns" | "adm" | "baidu" | "browser" | "gcm" | "wns";
     /**
      * The tags used for targeting this installation.
      */
@@ -1142,30 +1281,59 @@ export declare type JsonPatchOperation = "add" | "remove" | "replace";
  * Represents a Windows Phone Notification Services registration description.
  * @deprecated Windows Phone is no longer supported.
  */
-export declare interface MpnsRegistrationDescription extends RegistrationDescriptionCommon {
+export declare interface MpnsRegistrationDescription extends MpnsRegistrationDescriptionCommon {
     /**
-     * The channel URI.
+     * The kind of the registration.
      */
-    channelUri: string;
+    kind: "Mpns";
+}
+
+/**
+ * Represents a Windows Phone Notification Services registration description.
+ * @deprecated Windows Phone is no longer supported.
+ */
+export declare interface MpnsRegistrationDescriptionCommon extends RegistrationDescriptionCommon {
     /**
-     * The type of the registration.
+     * The channel URI.
      */
-    type: "Mpns";
+    channelUri: string;
 }
 
 /**
  * Represents a Windows Phone Notification Services template registration.
  * @deprecated Windows Phone is no longer supported.
  */
-export declare interface MpnsTemplateRegistrationDescription extends Omit<MpnsRegistrationDescription, "type">, TemplateRegistrationDescription {
+export declare interface MpnsTemplateRegistrationDescription extends MpnsRegistrationDescriptionCommon, TemplateRegistrationDescription {
     /**
      * The WNS headers.
      */
     mpnsHeaders?: Record<string, string>;
     /**
-     * The type of the registration.
+     * The kind of the registration.
+     */
+    kind: "MpnsTemplate";
+}
+
+/**
+ * Represents a Windows Phone Notification Services template registration.
+ * @deprecated Windows Phone is no longer supported.
+ */
+export declare interface MpnsTemplateRegistrationDescription extends MpnsTemplateRegistrationDescriptionCommon {
+    /**
+     * The kind of the registration.
      */
-    type: "MpnsTemplate";
+    kind: "MpnsTemplate";
+}
+
+/**
+ * Represents a Windows Phone Notification Services template registration.
+ * @deprecated Windows Phone is no longer supported.
+ */
+export declare interface MpnsTemplateRegistrationDescriptionCommon extends MpnsRegistrationDescriptionCommon, TemplateRegistrationDescription {
+    /**
+     * The WNS headers.
+     */
+    mpnsHeaders?: Record<string, string>;
 }
 
 /**
@@ -1185,14 +1353,6 @@ export declare interface NotificationCommon {
      * The headers to include for the push notification.
      */
     headers?: Record<string, string>;
-    /**
-     * The platform for the push notification.
-     */
-    platform: string;
-    /**
-     * The content type for the push notification.
-     */
-    contentType: string;
 }
 
 /**
@@ -1242,27 +1402,27 @@ export declare interface NotificationDetails {
     /**
      * APNs outcomes counts per state.
      */
-    apnsOutcomeCounts?: NotificationOutcomeCollectionItem[];
+    apnsOutcomeCounts?: NotificationOutcome[];
     /**
      * WNS outcomes counts per state.
      */
-    wnsOutcomeCounts?: NotificationOutcomeCollectionItem[];
+    wnsOutcomeCounts?: NotificationOutcome[];
     /**
      * FCM outcome counts per state.
      */
-    fcmOutcomeCounts?: NotificationOutcomeCollectionItem[];
+    fcmOutcomeCounts?: NotificationOutcome[];
     /**
      * ADM outcome counts per state.
      */
-    admOutcomeCounts?: NotificationOutcomeCollectionItem[];
+    admOutcomeCounts?: NotificationOutcome[];
     /**
      * Baidu outcome counts per state.
      */
-    baiduOutcomeCounts?: NotificationOutcomeCollectionItem[];
+    baiduOutcomeCounts?: NotificationOutcome[];
     /**
      * Web Push outcome counts per state.
      */
-    browserOutcomeCounts?: NotificationOutcomeCollectionItem[];
+    browserOutcomeCounts?: NotificationOutcome[];
 }
 
 /**
@@ -1376,61 +1536,11 @@ export declare type NotificationHubJobType =
 */
 | "ImportUpsertRegistrations";
 
-/**
- * Describes the options that can be provided while creating the NotificationHubsClientContext.
- */
-export declare interface NotificationHubsClientOptions extends CommonClientOptions {
-}
-
-/**
- * Describes a response from the Notification Hubs service for send operations.
- */
-export declare interface NotificationHubsMessageResponse extends NotificationHubsResponse {
-    /**
-     * The notification ID from the operation.  Note this is only available in Standard SKU and above.
-     */
-    notificationId?: string;
-    /**
-     * The number of devices that successfully received the notification.
-     */
-    success: number;
-    /**
-     * The number of devices that failed to receive a notification.
-     */
-    failure: number;
-    /**
-     * The list of notification outcome results for each device registered with the hub, to which this notification was sent.
-     */
-    results: RegistrationResult[];
-    /**
-     * The state of this notification outcome.
-     */
-    state: NotificationOutcomeState;
-}
-
-/**
- * Describes a response from the Notification Hubs which includes a tracking ID, correlation ID and location.
- */
-export declare interface NotificationHubsResponse {
-    /**
-     * The Tracking ID of the operation.
-     */
-    trackingId?: string;
-    /**
-     * The correlation ID of the operation.
-     */
-    correlationId?: string;
-    /**
-     * The location of the operation.
-     */
-    location?: string;
-}
-
 /**
  * This represents a client for Azure Notification Hubs to manage installations and send
  * messages to devices.
  */
-export declare class NotificationHubsServiceClient {
+export declare class NotificationHubsClient {
     private _client;
     /**
      * Creates a new instance of the NotificationClient with a connection string, hub name and options.
@@ -1513,10 +1623,17 @@ export declare class NotificationHubsServiceClient {
     getRegistration(registrationId: string, options?: OperationOptions): Promise<RegistrationDescription>;
     /**
      * Gets all registrations for the notification hub with the given query options.
-     * @param options - The options for querying the registrations such as $top and $filter.
+     * @param options - The options for querying the registrations such as $top.
      * @returns A paged async iterable containing all of the registrations for the notification hub.
      */
-    listRegistrations(options?: RegistrationQueryOptions): PagedAsyncIterableIterator<RegistrationDescription>;
+    listRegistrations(options?: RegistrationQueryLimitOptions): PagedAsyncIterableIterator<RegistrationDescription>;
+    /**
+     * Gets all registrations for the notification hub with the given device information and options.
+     * @param channel - The registration channel information to query per PNS type.
+     * @param options - The options for querying the registrations such as $top.
+     * @returns A paged async iterable containing all of the registrations for the notification hub.
+     */
+    listRegistrationsByChannel(channel: RegistrationChannel, options?: RegistrationQueryLimitOptions): PagedAsyncIterableIterator<RegistrationDescription>;
     /**
      * Lists all registrations with the matching tag.
      * @param tag - The tag to query for matching registrations.
@@ -1591,10 +1708,60 @@ export declare class NotificationHubsServiceClient {
     listNotificationHubJobs(options?: OperationOptions): Promise<NotificationHubJob[]>;
 }
 
+/**
+ * Describes the options that can be provided while creating the NotificationHubsClientContext.
+ */
+export declare interface NotificationHubsClientOptions extends CommonClientOptions {
+}
+
+/**
+ * Describes a response from the Notification Hubs service for send operations.
+ */
+export declare interface NotificationHubsMessageResponse extends NotificationHubsResponse {
+    /**
+     * The notification ID from the operation.  Note this is only available in Standard SKU and above.
+     */
+    notificationId?: string;
+    /**
+     * The number of devices that successfully received the notification.
+     */
+    successCount: number;
+    /**
+     * The number of devices that failed to receive a notification.
+     */
+    failureCount: number;
+    /**
+     * The list of notification outcome results for each device registered with the hub, to which this notification was sent.
+     */
+    results: RegistrationResult[];
+    /**
+     * The state of this notification outcome.
+     */
+    state: NotificationOutcomeState;
+}
+
+/**
+ * Describes a response from the Notification Hubs which includes a tracking ID, correlation ID and location.
+ */
+export declare interface NotificationHubsResponse {
+    /**
+     * The Tracking ID of the operation.
+     */
+    trackingId?: string;
+    /**
+     * The correlation ID of the operation.
+     */
+    correlationId?: string;
+    /**
+     * The location of the operation.
+     */
+    location?: string;
+}
+
 /**
  * The per platform count per state.
  */
-export declare interface NotificationOutcomeCollectionItem {
+export declare interface NotificationOutcome {
     /**
      * The state of the notification.
      */
@@ -1625,6 +1792,11 @@ export declare interface PolledOperationOptions extends OperationOptions {
  */
 export declare type PushHandle = BrowserPushChannel | string;
 
+/**
+ * Describes a Registration query.
+ */
+export declare type RegistrationChannel = AdmRegistrationChannel | AppleRegistrationChannel | BaiduRegistrationChannel | BrowserRegistrationChannel | FirebaseLegacyRegistrationChannel | WindowsRegistrationChannel;
+
 /**
  * Describes the types of registration descriptions.
  */
@@ -1654,10 +1826,6 @@ export declare interface RegistrationDescriptionCommon {
      * A dictionary of push variables associated with property bag.
      */
     pushVariables?: Record<string, string>;
-    /**
-     * The type of the registration.
-     */
-    type: RegistrationType;
 }
 
 /**
@@ -1726,10 +1894,10 @@ export declare type RegistrationType = "Adm" | "AdmTemplate" | "Apple" | "AppleT
  */
 export declare interface ScheduleNotificationOptions extends OperationOptions {
     /**
-     * The tags used to target the device for push notifications in either an array as "an || condition" or tag expression.
+     * A tag expression used to target devices. Use the `createTagExpression` function to create a tag expression from an array of tags.
      * If not set, this results in a broadcast notification to be scheduled.
      */
-    tags?: string | string[];
+    tagExpression?: string;
 }
 
 /**
@@ -1737,10 +1905,10 @@ export declare interface ScheduleNotificationOptions extends OperationOptions {
  */
 export declare interface SendNotificationOptions extends OperationOptions {
     /**
-     * The tags used to target the device for push notifications in either an array as "an || condition" or tag expression.
+     * A tag expression used to target devices. Use the `createTagExpression` function to create a tag expression from an array of tags.
      * If not set, this results in a broadcast notification to be sent.
      */
-    tags?: string | string[];
+    tagExpression?: string;
     /**
      * Set to true to enable test send.
      */
@@ -1815,32 +1983,58 @@ export declare interface WindowsNotification extends NotificationCommon {
     contentType: WindowsContentType;
 }
 
+/**
+ * Describes an Windows Notification Services Registration channel query.
+ */
+export declare interface WindowsRegistrationChannel {
+    /**
+     * The WNS Channel URI.
+     */
+    channelUri: string;
+    /**
+     * The kind of the registration channel.
+     */
+    kind: "windows";
+}
+
 /**
  * Represents a Windows Notification Services (WNS) registration description.
  */
-export declare interface WindowsRegistrationDescription extends RegistrationDescriptionCommon {
+export declare interface WindowsRegistrationDescription extends WindowsRegistrationDescriptionCommon {
+    /**
+     * The kind of the registration.
+     */
+    kind: "Windows";
+}
+
+/**
+ * Represents a Windows Notification Services (WNS) registration description.
+ */
+export declare interface WindowsRegistrationDescriptionCommon extends RegistrationDescriptionCommon {
     /**
      * The channel URI.
      */
     channelUri: string;
+}
+
+/**
+ * Represents a Windows Notification Services (WNS) template registration.
+ */
+export declare interface WindowsTemplateRegistrationDescription extends WindowsTemplateRegistrationDescriptionCommon {
     /**
-     * The type of the registration.
+     * The kind of the registration.
      */
-    type: "Windows";
+    kind: "WindowsTemplate";
 }
 
 /**
  * Represents a Windows Notification Services (WNS) template registration.
  */
-export declare interface WindowsTemplateRegistrationDescription extends Omit<WindowsRegistrationDescription, "type">, TemplateRegistrationDescription {
+export declare interface WindowsTemplateRegistrationDescriptionCommon extends WindowsRegistrationDescriptionCommon, TemplateRegistrationDescription {
     /**
      * The WNS headers.
      */
     wnsHeaders?: Record<string, string>;
-    /**
-     * The type of the registration.
-     */
-    type: "WindowsTemplate";
 }
 
 export { }