@pushwoosh/rpc-v2-http-api-data 0.2.330 → 0.2.331

package/pushwoosh_channels_messagingApi_v2.d.ts

@@ -1,16 +1,86 @@
 import { RpcMethod, Duration } from './commonTypes';
 import { FilterExpression as pushwoosh_objects_filters_v1_FilterExpression } from './pushwoosh_objects_filters_v1';
+/**
+ * MessagesInProgressService is an INTERNAL service (exposed on the private gRPC
+ * port only). It surfaces the in-flight messages that the publisher tracks in
+ * Redis so operators can list stalled sends, inspect one, re-dispatch them, or
+ * clear their records from the admin panel.
+ *
+ * It deliberately has no HTTP gateway annotations: it is reached over gRPC by
+ * internal services (admin-grpc), never by public clients.
+ */
+export interface MessagesInProgressService {
+}
+export type MessageStalledStatusState = 'MESSAGE_STATUS_STATE_UNKNOWN' | 'MESSAGE_STATUS_STATE_ALIVE' | 'MESSAGE_STATUS_STATE_STUCK' | 'MESSAGE_STATUS_STATE_DEAD';
+export type MessageStalled = {
+    messageCode: string;
+    clientId: string;
+    state: MessageStalledStatusState;
+    processed: number;
+    isClientAlive: boolean;
+    accountId: number;
+    /** Last progress update; unset if absent. */
+    lastUpdated: Date;
+    /** Last resend; unset if the message was never resent. */
+    lastResend: Date;
+    sendDate: Date;
+};
+export type ListRequest = {};
+export type ListResponse = {
+    messages: MessageStalled[];
+};
+export type GetStalledMessageRequest = {
+    messageCode: string;
+};
+export type GetStalledMessageResponse = {
+    message: MessageStalled;
+};
+export type ResendMessageRequest = {
+    messageCode: string;
+};
+export type ResendMessageResponse = {};
+export type ClearMessageRequest = {
+    messageCode: string;
+};
+export type ClearMessageResponse = {};
 export type MessagingService_Notify = RpcMethod<NotifyRequest, NotifyResponse>;
-export type MessagingService_NotifyBulk = RpcMethod<NotifyBulkRequest, NotifyBulkResponse>;
+export type MessagingService_NotifyBatch = RpcMethod<NotifyBatchRequest, NotifyBatchResponse>;
+export type MessagingService_Cancel = RpcMethod<CancelRequest, CancelResponse>;
+export type MessagingService_Update = RpcMethod<UpdateRequest, UpdateResponse>;
+export type MessagingService_Delete = RpcMethod<DeleteRequest, DeleteResponse>;
 export interface MessagingService {
     /** Notify creates a new message. Can be targeted to a segment or a list of users. */
     Notify: MessagingService_Notify;
-    /** NotifyBulk creates several messages. */
-    NotifyBulk: MessagingService_NotifyBulk;
-    /** NotifyStream is async version of Notify. */
-    NotifyStream(request: NotifyStreamRequest, options?: {
-        signal?: AbortSignal;
-    }): Promise<AsyncIterable<NotifyStreamResponse>>;
+    /**
+     * NotifyBatch creates several messages in one call. Every item is an
+     * independent Notify: it is validated, authorized and sent on its own, and it
+     * gets its own result. The call itself succeeds even when every item failed,
+     * so the caller must read the per-item results and not just the status code.
+     *
+     * Intended for callers that cannot issue concurrent requests. It is not
+     * faster than the same items sent in parallel through Notify.
+     *
+     * Public API only: the fan-out re-enters through the public port, so calling
+     * this on the private port fails with Unimplemented.
+     */
+    NotifyBatch: MessagingService_NotifyBatch;
+    /**
+     * Cancel cancels a previously created message identified by message_code.
+     * Only messages in a cancelable state (pending, waiting, processing) can be canceled.
+     */
+    Cancel: MessagingService_Cancel;
+    /**
+     * Update replaces a previously created message identified by message_code with
+     * a new definition. Only messages still in the pending (scheduled) state can be
+     * updated. The message_code does not change.
+     */
+    Update: MessagingService_Update;
+    /**
+     * Delete permanently removes a previously created message identified by
+     * message_code. Only messages in a cancelable state (pending, waiting,
+     * processing) can be deleted.
+     */
+    Delete: MessagingService_Delete;
 }
 export type NotifyRequest_kind_segment = {
     type: 'segment';
@@ -22,27 +92,123 @@ export type NotifyRequest_kind_transactional = {
 };
 export type NotifyRequest_kind = NotifyRequest_kind_segment | NotifyRequest_kind_transactional;
 export type NotifyRequest = {
+    /**
+     * Optional idempotency key. When set, a repeated Notify with the same
+     * transaction_id (within the dedup TTL) does not resend the message and
+     * returns the original message_code. Mirrors legacy gateway transactionId.
+     */
+    transactionId?: string;
     kind: NotifyRequest_kind;
 };
 export type NotifyResponse = {
+    /** Result of the send. */
     result: NotifyResult;
 };
-export type NotifyBulkRequest = {
-    requests?: NotifyRequest[];
+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 NotifyBatchRequest = {
+    /**
+     * At most 500 entries; the exact limit is server-configured. Items are
+     * processed concurrently, but results come back in request order.
+     */
+    items?: NotifyBatchItem[];
 };
-export type NotifyBulkResponse = {
-    result: NotifyResult[];
+export type NotifyBatchItem = {
+    /**
+     * Caller-supplied correlation id, echoed back in the matching result and
+     * otherwise ignored. Optional.
+     */
+    itemId: string;
+    /**
+     * Same body as a single Notify, transaction_id included. Setting
+     * transaction_id per item is what makes retrying a batch safe.
+     */
+    request: NotifyRequest;
+};
+export type NotifyBatchResponse = {
+    /** One result per requested item, in the order the items were sent. */
+    results: NotifyBatchResult[];
+    /** Counts over results, so a caller can check the outcome without scanning. */
+    succeeded: number;
+    failed: number;
+};
+export type NotifyBatchResult = {
+    /** Echo of NotifyBatchItem.item_id. */
+    itemId: string;
+    /**
+     * Zero-based position of the item in the request, so results can be
+     * correlated even when item_id was left empty.
+     */
+    index: number;
+    /** Set when the item succeeded. */
+    result: NotifyResult;
+    /** Set when the item failed. */
+    error: NotifyBatchError;
 };
-export type NotifyStreamRequest = {
+/**
+ * NotifyBatchError carries what a single Notify would have returned as a gRPC
+ * error. It mirrors google.rpc.Status, but is declared here and with the
+ * ErrorInfo detail flattened into plain fields: the TypeScript client generator
+ * resolves only google.protobuf.* imports, and a flat shape spares REST callers
+ * from unpacking an Any.
+ */
+export type NotifyBatchError = {
+    /** gRPC status code, as in google.rpc.Code. */
+    code: number;
+    /** Developer-facing message, in English. */
+    message: string;
+    /**
+     * Short name of the messaging status code, same value a single Notify puts
+     * into the ErrorInfo detail. Empty when the failure carried no ErrorInfo.
+     */
+    reason: string;
+    /** Domain of the reason above. */
+    domain: string;
+};
+export type CancelRequest = {
+    /** Code of the message to cancel (as returned by Notify in NotifyResult.message_code). */
+    messageCode?: string;
+};
+export type CancelResponse = {};
+export type UpdateRequest = {
+    /** Code of the message to update (as returned by Notify in NotifyResult.message_code). */
+    messageCode?: string;
+    /** Full new definition of the message. Same shape as Notify (full replace, not a patch). */
     request?: NotifyRequest;
 };
-export type NotifyStreamResponse = {};
-export type NotifyResult = {
-    messageCode: string;
-    unknownIdentifiers: string[];
+export type UpdateResponse = {
+    /** Result carries the (unchanged) message_code and any unknown identifiers. */
+    result: NotifyResult;
 };
+export type DeleteRequest = {
+    /** Code of the message to delete (as returned by Notify in NotifyResult.message_code). */
+    messageCode?: string;
+};
+export type DeleteResponse = {};
 export type MessageType = 'MESSAGE_TYPE_UNSPECIFIED' | 'MESSAGE_TYPE_MARKETING' | 'MESSAGE_TYPE_TRANSACTIONAL';
-export type Platform = 'UNKNOWN' | 'IOS' | 'ANDROID' | 'OSX' | 'WINDOWS' | 'AMAZON' | 'SAFARI' | 'CHROME' | 'FIREFOX' | 'IE' | 'EMAIL' | 'BAIDU_ANDROID' | 'HUAWEI_ANDROID' | 'SMS' | 'WEB' | 'WHATS_APP' | 'LINE' | 'KAKAO' | 'TELEGRAM';
+/**
+ * RegistrationType controls whether destinations referenced by hwid / push token /
+ * user_id / email address / phone number that are NOT yet present in Pushwoosh
+ * should be created on the fly when the message is dispatched.
+ *
+ * Channel-agnostic: applies to email, SMS, WhatsApp, push tokens, hwids — anything
+ * the gateway tries to resolve to an existing device/user record.
+ */
+export type RegistrationType = 
+/** Use the application's default behaviour (skip unknown identifiers). */
+'REGISTRATION_TYPE_DEFAULT'
+/** Do not auto-create unknown identifiers; treat them as unknown. */
+ | 'REGISTRATION_TYPE_NONE'
+/**
+ * Force-create a device/user record for every recipient identifier provided
+ * in the request, even if it is unknown to Pushwoosh.
+ */
+ | 'REGISTRATION_TYPE_FORCE';
+export type Platform = 'UNKNOWN' | 'IOS' | 'ANDROID' | 'OSX' | 'WINDOWS' | 'AMAZON' | 'SAFARI' | 'CHROME' | 'FIREFOX' | 'IE' | 'EMAIL' | 'FB_MESSENGER' | 'BAIDU_ANDROID' | 'HUAWEI_ANDROID' | 'SMS' | 'WEB' | 'WHATS_APP' | 'LINE' | 'KAKAO' | 'TELEGRAM' | 'APPLE_WALLET' | 'GOOGLE_WALLET' | 'VIBER';
 export type NotifySegment_target_code = {
     type: 'code';
     data: string;
@@ -64,7 +230,15 @@ export type NotifySegment_messagePayload_emailPayload = {
     type: 'emailPayload';
     data: EmailPayload;
 };
-export type NotifySegment_messagePayload = NotifySegment_messagePayload_payload | NotifySegment_messagePayload_emailPayload;
+export type NotifySegment_messagePayload_smsPayload = {
+    type: 'smsPayload';
+    data: SMSPayload;
+};
+export type NotifySegment_messagePayload_appInboxPayload = {
+    type: 'appInboxPayload';
+    data: AppInboxPayload;
+};
+export type NotifySegment_messagePayload = NotifySegment_messagePayload_payload | NotifySegment_messagePayload_emailPayload | NotifySegment_messagePayload_smsPayload | NotifySegment_messagePayload_appInboxPayload;
 /**
  * NotifySegment defines a request to send a message to a segment of users.
  * Segment can be defined either by a segment code or by a seglang expression.
@@ -80,14 +254,29 @@ 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.
      * Used to control behavior like control group filtering.
      */
     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;
+    /**
+     * Share of users held out of this send, 1..20, drawn into a control group of
+     * its own. Mutually exclusive with control_group.
+     */
+    holdoutPercentage: number;
     target: NotifySegment_target;
     messagePayload: NotifySegment_messagePayload;
 };
@@ -125,7 +314,15 @@ export type NotifyTransactional_messagePayload_emailPayload = {
     type: 'emailPayload';
     data: EmailPayload;
 };
-export type NotifyTransactional_messagePayload = NotifyTransactional_messagePayload_payload | NotifyTransactional_messagePayload_emailPayload;
+export type NotifyTransactional_messagePayload_smsPayload = {
+    type: 'smsPayload';
+    data: SMSPayload;
+};
+export type NotifyTransactional_messagePayload_appInboxPayload = {
+    type: 'appInboxPayload';
+    data: AppInboxPayload;
+};
+export type NotifyTransactional_messagePayload = NotifyTransactional_messagePayload_payload | NotifyTransactional_messagePayload_emailPayload | NotifyTransactional_messagePayload_smsPayload | NotifyTransactional_messagePayload_appInboxPayload;
 export type NotifyTransactional = {
     /** Message schedule. */
     schedule: Schedule;
@@ -142,8 +339,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.
@@ -151,12 +351,24 @@ export type NotifyTransactional = {
      */
     messageType: MessageType;
     /**
-     * Point-level TTL. When set, it overrides per-platform TTL
+     * Global TTL. When set, it overrides per-platform TTL
      * values and the preset-level TTL, and is applied uniformly across every
-     * push platform (iOS, Android, Huawei, Baidu, Chrome, macOS, Safari, Amazon,
-     * Windows).
+     * push platform (iOS, Android, Huawei, Baidu, Chrome, macOS, Safari, Amazon, Windows).
      */
     ttl: Duration;
+    /** When true and target is Users, sends only to the device with the most recent Last Application Open timestamp. */
+    useLatestUserDevice: boolean;
+    /**
+     * Whether to auto-create unknown destination identifiers.
+     * 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;
 };
@@ -184,28 +396,121 @@ export type Schedule = {
     pastTimezonesBehaviour: Schedule_PastTimezonesBehaviour;
     sendDate: Schedule_sendDate;
 };
+/** FrequencyCappingMode anchors the capping counting window. */
+export type FrequencyCappingMode = 
+/** Rolling window: the last days*24 hours from the moment of sending. */
+'FREQUENCY_CAPPING_MODE_DEFAULT'
+/** Calendar days: the window starts at local midnight in the configured timezone. */
+ | '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;
+    /** IANA timezone name midnight is calculated in for the calendar day mode; empty means UTC. */
+    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 Stories_Page = {
+    /** URL of the full-screen image; required. */
+    image: string;
+    /** Seconds the page stays on screen; the SDK defaults to about 5. */
+    duration: number;
+    /** Text overlaid on the page. */
+    title: string;
+    /** Secondary text overlaid on the page. */
+    subtitle: string;
+    /** Deep link or URL the page button opens; the button needs it. */
+    link: string;
+    /** Title of the page button. */
+    buttonTitle: string;
+};
+/**
+ * Stories is the iOS push stories block the SDK Content Extension plays when the push is
+ * expanded. It reaches the device as `pw_stories` with the proto field names as keys.
+ */
+export type Stories = {
+    /** Pages in playback order, from 1 to 10. */
+    pages: Stories_Page[];
+};
+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;
+};
+/**
+ * LiveUpdate is the Android Live Updates payload (Android 16 / API 36),
+ * the Android counterpart of LiveActivity. It is serialized with protojson
+ * into the android_live_update message property and emitted on the wire as a
+ * dedicated pw_live object (never via root_params). Declared top-level so that
+ * Huawei/Baidu can adopt it later with a one-line proto change; FCM only for now.
+ * The json_name annotations define the exact pw_live wire keys verbatim.
+ */
+export type LiveUpdate = {
+    /** required */
+    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 = {
@@ -221,9 +526,15 @@ 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 WebPopup = {
+    /** Web popup (popup form content) code configured in the Control Panel. */
+    code: string;
+};
 export type OpenAction_kind_richMedia = {
     type: 'richMedia';
     data: RichMedia;
@@ -236,161 +547,307 @@ export type OpenAction_kind_link = {
     type: 'link';
     data: Link;
 };
-export type OpenAction_kind = OpenAction_kind_richMedia | OpenAction_kind_deepLink | OpenAction_kind_link;
+export type OpenAction_kind_webPopup = {
+    type: 'webPopup';
+    data: WebPopup;
+};
+export type OpenAction_kind = OpenAction_kind_richMedia | OpenAction_kind_deepLink | OpenAction_kind_link | OpenAction_kind_webPopup;
 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;
+    /**
+     * APNs delivery priority: 10 delivers immediately, 5 lets iOS batch it.
+     * Live Activity updates default to 5 and stay silent until 10 is set here.
+     */
+    apnsPriority: number;
+    /** Push stories shown when the notification is expanded; needs the SDK stories Content Extension. */
+    stories: Stories;
 };
 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';
@@ -404,24 +861,105 @@ 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 = {};
+export type Content_PlatformPropertiesAppInbox_CarouselSlide = {
+    imageUrl: string;
+    caption: string;
+};
+export type Content_PlatformPropertiesAppInbox = {
+    /** Title of the inbox entry. */
+    title: string;
+    /** Body of the inbox entry. */
+    body: string;
+    /** Small image shown next to the entry. */
+    iconUrl: string;
+    /** Large image shown inside the entry. */
+    bannerUrl: string;
+    /** Action performed when the user taps the entry. */
+    openAction: OpenAction;
+    /** Free-form JSON delivered to the SDK with the entry. */
+    customData: object;
+    /** Inbox cell layout: classic (default when empty), captioned, banner or carousel. */
+    layoutType: string;
+    /** Slides of the carousel layout. */
+    carousel: Content_PlatformPropertiesAppInbox_CarouselSlide[];
+    /** Per-platform override of open_action, keyed by the numeric platform code. */
+    openActions: Record<number, OpenAction>;
+};
+export type Content_PlatformPropertiesSMS = {
+    /** Notification body text. */
+    body: string;
+    /**
+     * MMS: a subject and attachment URLs turn the message into an MMS. Only providers with
+     * an MMS endpoint (AbleMobile) deliver them, the rest ignore both fields.
+     */
+    subject: string;
+    fileUrls: string[];
+    /** Attachment index the body text is shown after; 0 means after the first attachment. */
+    messageAt: number;
+};
 export type Content_PlatformPropertiesTelegram = {
+    /** Message text. */
     body: string;
+    /** JSON string with variables for the bot-side template. */
     contentVariables: string;
 };
+export type Content_PlatformPropertiesFBMessenger = {
+    /** Message text. */
+    body: string;
+    /** JSON string with variables substituted into the body. */
+    contentVariables: string;
+    /**
+     * Meta message tag (CONFIRMED_EVENT_UPDATE, POST_PURCHASE_UPDATE, ACCOUNT_UPDATE,
+     * HUMAN_AGENT). Required to reach a user outside the 24-hour messaging window.
+     */
+    messageTag: string;
+};
+export type Content_PlatformPropertiesViber = {
+    /** Notification body text. */
+    body: string;
+    /**
+     * Transactional template (Omni Messaging / MStat): reference a pre-approved template by
+     * id + language with key/value params instead of a free-text body.
+     */
+    templateId: string;
+    templateLang: string;
+    templateParams: Record<string, string>;
+    /**
+     * all_devices = false sends to the primary device (type 1701); true sends to all of the
+     * user's devices (type 1702). Unset == false == primary-only, so a plain bool is enough
+     * (no need to distinguish unset from false).
+     */
+    allDevices: boolean;
+    /**
+     * Rich media (MStat types 107/108/109), ignored with template_id. image is a public URL;
+     * the button needs both caption and action (URL or viber:// deep link) and a body.
+     */
+    image: string;
+    buttonCaption: string;
+    buttonAction: string;
+};
 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 = {
@@ -446,8 +984,14 @@ export type Content_PlatformPropertiesWhatsApp = {
     /** JSON string, map of template body placeholders (e.g. {"1":"John"}). */
     contentVariables: string;
     /**
-     * JSON string, map of button-URL placeholders keyed by button index
-     * (e.g. {"0":"https://..."}).
+     * JSON string, map of button placeholders keyed by the button's 0-based
+     * Meta index (its position among all of the template's buttons).
+     * A URL button uses the bare index as the key and its dynamic URL text as
+     * the value (e.g. {"0":"summer-sale"}). Buttons of other types encode the
+     * type in the key as "<index>:<type>": "<i>:coupon_code" for a COPY_CODE
+     * button (value = the coupon code), "<i>:CATALOG" (value = ""), "<i>:MPM"
+     * (value = JSON of product-section actions). A bare numeric key is sent as
+     * a URL button.
      */
     buttonUrlVariables: string;
     /**
@@ -455,25 +999,56 @@ export type Content_PlatformPropertiesWhatsApp = {
      * (e.g. {"image":"https://..."}).
      */
     headerVariables: string;
+    /**
+     * Public https link to one media file sent with `content` as its caption.
+     * The media kind (image / document / video) is derived from the extension.
+     */
+    attachment: 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;
+    /** App Inbox message content. */
+    appInbox: Content_PlatformPropertiesAppInbox;
+    /** Facebook Messenger message content. */
+    fbMessenger: Content_PlatformPropertiesFBMessenger;
 };
 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 = {
@@ -486,11 +1061,18 @@ 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;
 };
 /** Email attachments. */
@@ -519,4 +1101,38 @@ export type EmailPayload = {
     replyTo: EmailPayload_Address;
     /** Email template code to use for this email, must reference an existing Email Template. */
     emailTemplate: string;
+    /**
+     * Email preset code. When set, messaging-api resolves the preset into
+     * email_template + subject + from + reply_to (inline fields override the preset).
+     */
+    emailPreset: string;
+};
+export type AppInboxPayload_expiration_expirationDate = {
+    type: 'expirationDate';
+    data: Date;
+};
+export type AppInboxPayload_expiration_expiresIn = {
+    type: 'expiresIn';
+    data: Duration;
+};
+export type AppInboxPayload_expiration = AppInboxPayload_expiration_expirationDate | AppInboxPayload_expiration_expiresIn;
+/** AppInboxPayload is a message of the App Inbox channel. */
+export type AppInboxPayload = {
+    /**
+     * preset references a saved App Inbox preset by code. When set, messaging-api resolves the
+     * preset content into the per-language entry; inline content overrides the preset per language.
+     */
+    preset: string;
+    /** Per-locale content. The inbox entry is read from Content.app_inbox of each locale. */
+    content: LocalizedContent;
+    expiration: AppInboxPayload_expiration;
+};
+export type SMSPayload = {
+    /**
+     * preset references a saved SMS preset by code. When set, messaging-api resolves the
+     * preset content into the per-language SMS body; inline content overrides the preset per language.
+     */
+    preset: string;
+    /** Per-locale SMS content. SMS body is read from Content.sms.body of each locale. */
+    content: LocalizedContent;
 };