@pushwoosh/rpc-gateway-messaging 0.6.100 → 0.6.101

package/data.js

@@ -310,6 +310,9 @@ export const data = {
             },
             "useLatestUserDevice": {
                 "type": "boolean"
+            },
+            "controlGroup": {
+                "type": "string"
             }
         },
         "oneofs": {
@@ -420,6 +423,9 @@ export const data = {
             },
             "registrationType": {
                 "type": "pushwoosh.channels.messagingApi.v2.RegistrationType"
+            },
+            "controlGroup": {
+                "type": "string"
             }
         },
         "oneofs": {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@pushwoosh/rpc-gateway-messaging",
-    "version": "0.6.100",
+    "version": "0.6.101",
     "description": "Channels Messaging API gateway HTTP API Types and Data",
     "main": "index.js",
     "module": "index.js",

package/pushwoosh_channels_messagingApi_v2.d.ts

@@ -87,10 +87,13 @@ export type NotifyRequest = {
     kind: NotifyRequest_kind;
 };
 export type NotifyResponse = {
+    /** Result of the send. */
     result: NotifyResult;
 };
 export type NotifyResult = {
+    /** Code of the created message; use it with cancel, update and delete. */
     messageCode: string;
+    /** Requested identifiers no device or user was found for. */
     unknownIdentifiers: string[];
 };
 export type CancelRequest = {
@@ -174,8 +177,11 @@ export type NotifySegment = {
     frequencyCapping: FrequencyCapping;
     /** Campaign code */
     campaign: string;
+    /** Throttling for this message. */
     sendRate: SendRate;
+    /** Free-form JSON stored with the message and echoed in tracking-log events. */
     metaData: object;
+    /** Placeholder name to the value substituted into the message content. */
     dynamicContentPlaceholders: Record<string, string>;
     /**
      * Message type: marketing or transactional.
@@ -184,6 +190,11 @@ export type NotifySegment = {
     messageType: MessageType;
     /** When true, sends only to the device with the most recent Last Application Open timestamp per user. */
     useLatestUserDevice: boolean;
+    /**
+     * Control group to measure this message against, by group code or by group
+     * name. Empty uses the application's default control group.
+     */
+    controlGroup: string;
     target: NotifySegment_target;
     messagePayload: NotifySegment_messagePayload;
 };
@@ -242,8 +253,11 @@ export type NotifyTransactional = {
     frequencyCapping: FrequencyCapping;
     /** Campaign code */
     campaign: string;
+    /** Throttling for this message. */
     sendRate: SendRate;
+    /** Free-form JSON stored with the message and echoed in tracking-log events. */
     metaData: object;
+    /** Placeholder name to the value substituted into the message content. */
     dynamicContentPlaceholders: Record<string, string>;
     /**
      * Message type: marketing or transactional.
@@ -263,6 +277,12 @@ export type NotifyTransactional = {
      * See RegistrationType for semantics. Applies across channels (email, SMS, …).
      */
     registrationType: RegistrationType;
+    /**
+     * Control group to measure this message against, by group code or by group
+     * name. Empty uses the application's default control group. Only has an
+     * effect on a marketing message: a transactional one is never held back.
+     */
+    controlGroup: string;
     target: NotifyTransactional_target;
     messagePayload: NotifyTransactional_messagePayload;
 };
@@ -298,9 +318,13 @@ export type FrequencyCappingMode =
  | 'FREQUENCY_CAPPING_MODE_CALENDAR_DAY';
 /** Message frequency capping. */
 export type FrequencyCapping = {
+    /** Length of the capping window in days; counted together with count. */
     days: number;
+    /** How many messages a user may receive within the window. */
     count: number;
+    /** Do not count this message towards the user's capping quota. */
     exclude: boolean;
+    /** Ignore capping for this message and send it anyway. */
     avoid: boolean;
     /** How the counting window is anchored. Applies only together with explicit days and count. */
     mode: FrequencyCappingMode;
@@ -308,25 +332,38 @@ export type FrequencyCapping = {
     timezone: string;
 };
 export type SendRate = {
+    /** Messages per bucket; bounded by the account's send-rate restrictions. */
     value: number;
+    /** Time window the value applies to, e.g. "1s". */
     bucket: string;
+    /** Send at full speed, ignoring any configured send rate. */
     avoid: boolean;
 };
 export type DeliveryPriority = 'NORMAL' | 'HIGH';
 export type NotificationPriority = 'PRIORITY_UNSPECIFIED' | 'PRIORITY_MIN' | 'PRIORITY_LOW' | 'PRIORITY_DEFAULT' | 'PRIORITY_HIGH' | 'PRIORITY_MAX';
 export type LiveActivity = {
+    /** Live Activity event: "start", "update" or "end". */
     event: string;
+    /** Unix time after which an ended activity is dismissed. */
     dismissalDate: number;
+    /** Dynamic ContentState of the activity. */
     contentState: object;
+    /** Unix time after which the shown content counts as stale. */
     staleDate: number;
+    /** Ordering hint when several activities compete for the same slot. */
     relevanceScore: number;
+    /** Name of the ActivityAttributes type; required to start an activity. */
     attributesType: string;
+    /** Static attributes passed when the activity starts. */
     attributes: object;
+    /** Unix time the activity starts. */
     start: number;
 };
 export type LiveUpdate_Operation = 'OPERATION_UNSPECIFIED' | 'OPERATION_START' | 'OPERATION_UPDATE' | 'OPERATION_END';
 export type LiveUpdate_Segment = {
+    /** Segment color, hex. */
     color: string;
+    /** Segment length in progress units. */
     length: number;
 };
 /**
@@ -342,19 +379,30 @@ export type LiveUpdate = {
     operation: LiveUpdate_Operation;
     /** required */
     id: string;
+    /** Current progress value. */
     progress: number;
+    /** Show the progress bar without a known end. */
     progressIndeterminate: boolean;
+    /** Whether a progress bar is shown at all. */
     progressBar: boolean;
+    /** Colored segments the progress bar is split into. */
     segments: LiveUpdate_Segment[];
+    /** Free-form data passed to the app with the update. */
     extras: object;
+    /** Unix time the update refers to. */
     when: number;
+    /** Render `when` as a running timer. */
     chronometer: boolean;
+    /** Make the chronometer count down instead of up. */
     chronometerCountDown: boolean;
+    /** Show the `when` timestamp on the notification. */
     showWhen: boolean;
 };
 export type Link_Shortener = 'NONE' | 'BITLY';
 export type Link = {
+    /** URL opened when the user taps the notification. */
     url: string;
+    /** Link shortener applied to the URL: NONE or BITLY. */
     shortener: Link_Shortener;
 };
 export type RichMedia_kind_code = {
@@ -370,7 +418,9 @@ export type RichMedia = {
     kind: RichMedia_kind;
 };
 export type DeepLink = {
+    /** Deep link code configured in the Control Panel. */
     code: string;
+    /** Parameters substituted into the deep link; values support Liquid. */
     params: Record<string, string>;
 };
 export type OpenAction_kind_richMedia = {
@@ -390,161 +440,291 @@ export type OpenAction = {
     kind: OpenAction_kind;
 };
 export type Inbox = {
+    /** Image shown in the Message Inbox entry. */
     imageUrl: string;
+    /** When the entry is removed from the Message Inbox. */
     expirationDate: Date;
 };
 export type Content_GlobalProperties = {
+    /** TTL applied to every platform block that has none of its own. */
     timeToLive: Duration;
 };
 export type Content_PlatformPropertiesIos = {
+    /** Notification title. */
     title: string;
+    /** Notification subtitle. */
     subtitle: string;
+    /** Notification body text. */
     body: string;
+    /** How long the push service keeps the notification for a device that is offline. */
     timeToLive: Duration;
+    /** Critical alert; requires the Apple critical-alerts entitlement. */
     isCritical: boolean;
+    /** URL of a media attachment; needs the Notification Service Extension in the app. */
     attachment: string;
+    /** Sound file name played on arrival. */
     sound: string;
+    /** Thread identifier iOS groups notifications by. */
     threadId: string;
+    /** Badge value: absolute ("5") or relative ("+1"). */
     badges: string;
+    /** Trim the content to fit the notification. */
     trimContent: boolean;
+    /** UNNotificationCategory identifier holding the interactive actions. */
     categoryId: string;
+    /** Enables or suppresses the notification sound. */
     soundEnabled: boolean;
+    /** iOS interruption level: passive, active, time-sensitive or critical. */
     interruptionLevel: string;
+    /** Raw platform payload overrides merged into the outgoing push. */
     rootParams: object;
+    /** Live Activity payload. */
     liveActivity: LiveActivity;
+    /** APNs collapse identifier: a newer notification replaces one with the same id. */
     collapseId: string;
+    /** Message Inbox entry created for this notification. */
     inbox: Inbox;
+    /** Id of the Live Activity this push starts or updates. */
     liveActivityId: string;
 };
 export type Content_PlatformPropertiesAndroid = {
+    /** Notification title. */
     title: string;
+    /** Notification body text. */
     body: string;
+    /** How long the push service keeps the notification for a device that is offline. */
     timeToLive: Duration;
+    /** Notification small icon. */
     icon: string;
+    /** Big-picture image URL shown in the expanded notification. */
     banner: string;
+    /** FCM delivery priority: NORMAL or HIGH. */
     deliveryPriority: DeliveryPriority;
+    /** Vibrate when the notification arrives. */
     vibration: boolean;
+    /** Badge value: absolute ("5") or relative ("+1"). */
     badges: string;
+    /** Sound file name played on arrival. */
     sound: string;
+    /** Notification LED color, hex. */
     ledColor: string;
+    /** Enables or suppresses the notification sound. */
     soundEnabled: boolean;
+    /** Icon background color, hex. */
     iconBackgroundColor: string;
+    /** Show the notification on the lock screen. */
     showOnLockscreen: boolean;
+    /** Raw platform payload overrides merged into the outgoing push. */
     rootParams: object;
+    /** URL of a large custom icon. */
     customIcon: string;
+    /** In-tray notification priority. */
     priority: NotificationPriority;
+    /** Notification group key the device stacks notifications by. */
     groupId: string;
+    /** FCM collapse key: a newer notification replaces an undelivered one with the same key. */
     collapseKey: string;
+    /** Message Inbox entry created for this notification. */
     inbox: Inbox;
+    /** Android Live Updates payload (Android 16+, FCM only). */
     liveUpdate: LiveUpdate;
 };
 export type Content_PlatformPropertiesChrome = {
+    /** Notification title. */
     title: string;
+    /** Notification body text. */
     body: string;
+    /** How long the push service keeps the notification for a device that is offline. */
     timeToLive: Duration;
+    /** Notification small icon. */
     icon: string;
+    /** Large image URL. */
     image: string;
+    /** Raw platform payload overrides merged into the outgoing push. */
     rootParams: object;
+    /** Auto-close timer for the notification. */
     duration: Duration;
+    /** Label of the first action button. */
     buttonText1: string;
+    /** URL opened by the first action button. */
     buttonUrl1: string;
+    /** Label of the second action button. */
     buttonText2: string;
+    /** URL opened by the second action button. */
     buttonUrl2: string;
+    /** Message Inbox entry created for this notification. */
     inbox: Inbox;
 };
 export type Content_PlatformPropertiesFirefox = {
+    /** Notification title. */
     title: string;
+    /** Notification body text. */
     body: string;
+    /** Notification small icon. */
     icon: string;
+    /** Raw platform payload overrides merged into the outgoing push. */
     rootParams: object;
+    /** Message Inbox entry created for this notification. */
     inbox: Inbox;
 };
 export type Content_PlatformPropertiesSafari = {
+    /** Notification title. */
     title: string;
+    /** Notification body text. */
     body: string;
+    /** How long the push service keeps the notification for a device that is offline. */
     timeToLive: Duration;
+    /** URL opened when the user clicks the notification. */
     action: string;
+    /** Arguments substituted into the site's Web Push URL template. */
     urlArguments: string[];
+    /** Message Inbox entry created for this notification. */
     inbox: Inbox;
 };
 export type Content_PlatformPropertiesMacOS = {
+    /** Notification title. */
     title: string;
+    /** Notification body text. */
     body: string;
+    /** How long the push service keeps the notification for a device that is offline. */
     timeToLive: Duration;
+    /** URL opened when the user clicks the notification. */
     action: string;
+    /** Sound file name played on arrival. */
     sound: string;
+    /** Enables or suppresses the notification sound. */
     soundEnabled: boolean;
+    /** Badge value: absolute ("5") or relative ("+1"). */
     badges: string;
+    /** Raw platform payload overrides merged into the outgoing push. */
     rootParams: object;
+    /** Message Inbox entry created for this notification. */
     inbox: Inbox;
+    /** Notification subtitle. */
     subtitle: string;
 };
 export type Content_PlatformPropertiesAmazon = {
+    /** Notification title. */
     title: string;
+    /** Notification body text. */
     body: string;
+    /** How long the push service keeps the notification for a device that is offline. */
     timeToLive: Duration;
+    /** Big-picture image URL shown in the expanded notification. */
     banner: string;
+    /** Sound file name played on arrival. */
     sound: string;
+    /** Enables or suppresses the notification sound. */
     soundEnabled: boolean;
+    /** Raw platform payload overrides merged into the outgoing push. */
     rootParams: object;
+    /** Notification small icon. */
     icon: string;
+    /** URL of a large custom icon. */
     customIcon: string;
+    /** In-tray notification priority. */
     priority: NotificationPriority;
+    /** Message Inbox entry created for this notification. */
     inbox: Inbox;
 };
 export type Content_PlatformPropertiesBaiduAndroid = {
+    /** Notification title. */
     title: string;
+    /** Notification body text. */
     body: string;
+    /** How long the push service keeps the notification for a device that is offline. */
     timeToLive: Duration;
+    /** Notification small icon. */
     icon: string;
+    /** Big-picture image URL shown in the expanded notification. */
     banner: string;
+    /** FCM delivery priority: NORMAL or HIGH. */
     deliveryPriority: DeliveryPriority;
+    /** Vibrate when the notification arrives. */
     vibration: boolean;
+    /** Badge value: absolute ("5") or relative ("+1"). */
     badges: string;
+    /** Sound file name played on arrival. */
     sound: string;
+    /** Notification LED color, hex. */
     ledColor: string;
+    /** Enables or suppresses the notification sound. */
     soundEnabled: boolean;
+    /** Icon background color, hex. */
     iconBackgroundColor: string;
+    /** Show the notification on the lock screen. */
     showOnLockscreen: boolean;
+    /** Raw platform payload overrides merged into the outgoing push. */
     rootParams: object;
+    /** URL of a large custom icon. */
     customIcon: string;
+    /** In-tray notification priority. */
     priority: NotificationPriority;
+    /** Notification group key the device stacks notifications by. */
     groupId: string;
+    /** Message Inbox entry created for this notification. */
     inbox: Inbox;
 };
 export type Content_PlatformPropertiesHuaweiAndroid = {
+    /** Notification title. */
     title: string;
+    /** Notification body text. */
     body: string;
+    /** How long the push service keeps the notification for a device that is offline. */
     timeToLive: Duration;
+    /** Notification small icon. */
     icon: string;
+    /** Big-picture image URL shown in the expanded notification. */
     banner: string;
+    /** FCM delivery priority: NORMAL or HIGH. */
     deliveryPriority: DeliveryPriority;
+    /** Vibrate when the notification arrives. */
     vibration: boolean;
+    /** Badge value: absolute ("5") or relative ("+1"). */
     badges: string;
+    /** Sound file name played on arrival. */
     sound: string;
+    /** Notification LED color, hex. */
     ledColor: string;
+    /** Enables or suppresses the notification sound. */
     soundEnabled: boolean;
+    /** Icon background color, hex. */
     iconBackgroundColor: string;
+    /** Show the notification on the lock screen. */
     showOnLockscreen: boolean;
+    /** Raw platform payload overrides merged into the outgoing push. */
     rootParams: object;
+    /** URL of a large custom icon. */
     customIcon: string;
+    /** In-tray notification priority. */
     priority: NotificationPriority;
+    /** Notification group key the device stacks notifications by. */
     groupId: string;
+    /** Message Inbox entry created for this notification. */
     inbox: Inbox;
 };
 export type Content_PlatformPropertiesIE = {
+    /** Notification title. */
     title: string;
+    /** Badge icon URL. */
     iconBadge: string;
+    /** Notification body text. */
     body: string;
+    /** Message Inbox entry created for this notification. */
     inbox: Inbox;
 };
 export type Content_PlatformPropertiesWindows_Raw = {
+    /** Raw toast/tile XML sent to WNS as is. */
     content: string;
 };
 export type Content_PlatformPropertiesWindows_Template = {
+    /** Notification title. */
     title: string;
+    /** Notification subtitle. */
     subtitle: string;
+    /** Notification body text. */
     body: string;
+    /** Image shown in the notification. */
     imageUrl: string;
 };
 export type Content_PlatformPropertiesWindows_Type = 'TILE' | 'TOAST' | 'BADGE';
@@ -558,13 +738,18 @@ export type Content_PlatformPropertiesWindows_content_template = {
 };
 export type Content_PlatformPropertiesWindows_content = Content_PlatformPropertiesWindows_content_raw | Content_PlatformPropertiesWindows_content_template;
 export type Content_PlatformPropertiesWindows = {
+    /** Notification kind: TILE, TOAST or BADGE. */
     type: Content_PlatformPropertiesWindows_Type;
+    /** WNS tag; a newer notification with the same tag replaces the previous one. */
     tag: string;
+    /** Let WNS cache the notification for an offline device. */
     cache: boolean;
+    /** How long the push service keeps the notification for a device that is offline. */
     timeToLive: Duration;
     content: Content_PlatformPropertiesWindows_content;
 };
 export type Content_PlatformPropertiesSMS = {
+    /** Notification body text. */
     body: string;
     /**
      * MMS: a subject and attachment URLs turn the message into an MMS. Only providers with
@@ -576,10 +761,13 @@ export type Content_PlatformPropertiesSMS = {
     messageAt: number;
 };
 export type Content_PlatformPropertiesTelegram = {
+    /** Message text. */
     body: string;
+    /** JSON string with variables for the bot-side template. */
     contentVariables: string;
 };
 export type Content_PlatformPropertiesViber = {
+    /** Notification body text. */
     body: string;
     /**
      * Transactional template (Omni Messaging / MStat): reference a pre-approved template by
@@ -596,12 +784,17 @@ export type Content_PlatformPropertiesViber = {
     allDevices: boolean;
 };
 export type Content_PlatformPropertiesKakao = {
+    /** Message text. */
     content: string;
+    /** Code of the approved Kakao template. */
     template: string;
+    /** JSON string with the template variable bindings. */
     contentVariables: string;
 };
 export type Content_PlatformPropertiesLine = {
+    /** Plain text body. */
     content: string;
+    /** Code of a LINE template configured in the Control Panel (image, carousel or flex message). */
     template: string;
 };
 export type Content_PlatformPropertiesWhatsApp = {
@@ -643,26 +836,45 @@ export type Content_PlatformPropertiesWhatsApp = {
     headerVariables: string;
 };
 export type Content = {
+    /** iOS push content. */
     ios: Content_PlatformPropertiesIos;
+    /** Android (FCM) push content. */
     android: Content_PlatformPropertiesAndroid;
+    /** macOS push content. */
     macOs: Content_PlatformPropertiesMacOS;
+    /** Amazon (ADM) push content. */
     amazon: Content_PlatformPropertiesAmazon;
+    /** Safari web push content. */
     safari: Content_PlatformPropertiesSafari;
+    /** Chrome web push content. */
     chrome: Content_PlatformPropertiesChrome;
+    /** Firefox web push content. */
     firefox: Content_PlatformPropertiesFirefox;
+    /** Baidu Android push content. */
     baiduAndroid: Content_PlatformPropertiesBaiduAndroid;
+    /** Huawei Android push content. */
     huaweiAndroid: Content_PlatformPropertiesHuaweiAndroid;
+    /** Internet Explorer web push content. */
     ie: Content_PlatformPropertiesIE;
+    /** Windows tile/toast/badge content. */
     windows: Content_PlatformPropertiesWindows;
+    /** Telegram message content. */
     telegram: Content_PlatformPropertiesTelegram;
+    /** Kakao message content. */
     kakao: Content_PlatformPropertiesKakao;
+    /** LINE message content. */
     line: Content_PlatformPropertiesLine;
+    /** WhatsApp message content. */
     whatsapp: Content_PlatformPropertiesWhatsApp;
+    /** Settings applied to every platform block of this locale. */
     globalProperties: Content_GlobalProperties;
+    /** SMS (and MMS) message content. */
     sms: Content_PlatformPropertiesSMS;
+    /** Viber message content. */
     viber: Content_PlatformPropertiesViber;
 };
 export type LocalizedContent = {
+    /** Locale code (ISO 639-1, "zh-Hant"/"zh-Hans", or "default") to the content sent to devices in that language. */
     localizedContent: Record<string, Content>;
 };
 export type Payload_kind_content = {
@@ -675,11 +887,17 @@ export type Payload_kind_silent = {
 };
 export type Payload_kind = Payload_kind_content | Payload_kind_silent;
 export type Payload = {
+    /** Push preset code (XXXXX-XXXXX) whose content this message starts from. */
     preset: string;
+    /** Free-form JSON delivered to the SDK as the `u` parameter. */
     customData: object;
+    /** Action performed when the user opens the notification. */
     openAction: OpenAction;
+    /** Per-platform override of open_action, keyed by the numeric platform code. */
     openActions: Record<number, OpenAction>;
+    /** Send as an iOS VoIP notification. */
     voipPush: boolean;
+    /** Serial of the Apple Wallet pass to update; requires the APPLE_WALLET platform. */
     appleWalletPassSerial: string;
     kind: Payload_kind;
 };