@pushwoosh/rpc-gateway-messaging 0.6.31

package/index.d.ts

@@ -0,0 +1,9 @@
+import { MessagesInProgressService as pushwoosh_channels_messagingApi_v2_MessagesInProgressService } from './pushwoosh_channels_messagingApi_v2';
+import { MessagingService as pushwoosh_channels_messagingApi_v2_MessagingService } from './pushwoosh_channels_messagingApi_v2';
+import { FiltersCrudService as pushwoosh_objects_filters_v1_FiltersCrudService } from './pushwoosh_objects_filters_v1';
+export type API = {
+    messagesInProgress: pushwoosh_channels_messagingApi_v2_MessagesInProgressService;
+    messaging: pushwoosh_channels_messagingApi_v2_MessagingService;
+    filtersCrud: pushwoosh_objects_filters_v1_FiltersCrudService;
+};
+export { data } from './data';

package/index.js

@@ -0,0 +1,3 @@
+/* eslint-disable */
+/* Autogenerated code */
+export { data } from './data';

package/package.json

@@ -0,0 +1,19 @@
+{
+    "name": "@pushwoosh/rpc-gateway-messaging",
+    "version": "0.6.31",
+    "description": "Channels Messaging API gateway HTTP API Types and Data",
+    "main": "index.js",
+    "module": "index.js",
+    "types": "index.d.js",
+    "sideEffects": false,
+    "repository": {
+        "type": "git",
+        "url": "https://gitlab.corp.pushwoosh.com/channels/api/messaging"
+    },
+    "keywords": [
+        "RPC",
+        "Pushwoosh",
+        "API"
+    ],
+    "author": "Pushwoosh"
+}

package/pushwoosh_channels_messagingApi_v2.d.ts

@@ -0,0 +1,602 @@
+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;
+};
+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_Cancel = RpcMethod<CancelRequest, CancelResponse>;
+export interface MessagingService {
+    /** Notify creates a new message. Can be targeted to a segment or a list of users. */
+    Notify: MessagingService_Notify;
+    /**
+     * 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;
+}
+export type NotifyRequest_kind_segment = {
+    type: 'segment';
+    data: NotifySegment;
+};
+export type NotifyRequest_kind_transactional = {
+    type: 'transactional';
+    data: NotifyTransactional;
+};
+export type NotifyRequest_kind = NotifyRequest_kind_segment | NotifyRequest_kind_transactional;
+export type NotifyRequest = {
+    kind: NotifyRequest_kind;
+};
+export type NotifyResponse = {
+    result: NotifyResult;
+};
+export type NotifyResult = {
+    messageCode: string;
+    unknownIdentifiers: 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 MessageType = 'MESSAGE_TYPE_UNSPECIFIED' | 'MESSAGE_TYPE_MARKETING' | 'MESSAGE_TYPE_TRANSACTIONAL';
+/**
+ * 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' | 'BAIDU_ANDROID' | 'HUAWEI_ANDROID' | 'SMS' | 'WEB' | 'WHATS_APP' | 'LINE' | 'KAKAO' | 'TELEGRAM';
+export type NotifySegment_target_code = {
+    type: 'code';
+    data: string;
+};
+export type NotifySegment_target_expression = {
+    type: 'expression';
+    data: string;
+};
+export type NotifySegment_target_filterExpression = {
+    type: 'filterExpression';
+    data: pushwoosh_objects_filters_v1_FilterExpression;
+};
+export type NotifySegment_target = NotifySegment_target_code | NotifySegment_target_expression | NotifySegment_target_filterExpression;
+export type NotifySegment_messagePayload_payload = {
+    type: 'payload';
+    data: Payload;
+};
+export type NotifySegment_messagePayload_emailPayload = {
+    type: 'emailPayload';
+    data: EmailPayload;
+};
+export type NotifySegment_messagePayload = NotifySegment_messagePayload_payload | NotifySegment_messagePayload_emailPayload;
+/**
+ * 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.
+ */
+export type NotifySegment = {
+    /** Message schedule. */
+    schedule: Schedule;
+    /** Application code to get hwids, users and push tokens from. */
+    application: string;
+    /** List of platform. */
+    platforms: Platform[];
+    /** Message frequency capping. */
+    frequencyCapping: FrequencyCapping;
+    /** Campaign code */
+    campaign: string;
+    sendRate: SendRate;
+    metaData: object;
+    dynamicContentPlaceholders: Record<string, string>;
+    /**
+     * Message type: marketing or transactional.
+     * Used to control behavior like control group filtering.
+     */
+    messageType: MessageType;
+    /**
+     * Whether to auto-create unknown destination identifiers.
+     * See RegistrationType for semantics. Applies across channels (email, SMS, …).
+     */
+    registrationType: RegistrationType;
+    target: NotifySegment_target;
+    messagePayload: NotifySegment_messagePayload;
+};
+export type NotifyTransactional_HwidsList = {
+    list: string[];
+};
+export type NotifyTransactional_UsersList = {
+    list: string[];
+};
+export type NotifyTransactional_PushTokensList = {
+    list: string[];
+};
+export type NotifyTransactional_target_testDevices = {
+    type: 'testDevices';
+    data: boolean;
+};
+export type NotifyTransactional_target_hwids = {
+    type: 'hwids';
+    data: NotifyTransactional_HwidsList;
+};
+export type NotifyTransactional_target_users = {
+    type: 'users';
+    data: NotifyTransactional_UsersList;
+};
+export type NotifyTransactional_target_pushTokens = {
+    type: 'pushTokens';
+    data: NotifyTransactional_PushTokensList;
+};
+export type NotifyTransactional_target = NotifyTransactional_target_testDevices | NotifyTransactional_target_hwids | NotifyTransactional_target_users | NotifyTransactional_target_pushTokens;
+export type NotifyTransactional_messagePayload_payload = {
+    type: 'payload';
+    data: Payload;
+};
+export type NotifyTransactional_messagePayload_emailPayload = {
+    type: 'emailPayload';
+    data: EmailPayload;
+};
+export type NotifyTransactional_messagePayload = NotifyTransactional_messagePayload_payload | NotifyTransactional_messagePayload_emailPayload;
+export type NotifyTransactional = {
+    /** Message schedule. */
+    schedule: Schedule;
+    /** Application code to get hwids, users and push tokens from. */
+    application: string;
+    /** List of platform. */
+    platforms: Platform[];
+    /**
+     * Flag indicating whether to return the list of unknown identifiers.
+     * If true, the response will include the 'unknown_identifiers' field
+     */
+    returnUnknownIdentifiers: boolean;
+    /** Message frequency capping. */
+    frequencyCapping: FrequencyCapping;
+    /** Campaign code */
+    campaign: string;
+    sendRate: SendRate;
+    metaData: object;
+    dynamicContentPlaceholders: Record<string, string>;
+    /**
+     * Message type: marketing or transactional.
+     * Used to control behavior like control group filtering.
+     */
+    messageType: MessageType;
+    /**
+     * 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).
+     */
+    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;
+    target: NotifyTransactional_target;
+    messagePayload: NotifyTransactional_messagePayload;
+};
+export type Schedule_PastTimezonesBehaviour = 'PAST_TIMEZONES_BEHAVIOUR_DEFAULT'
+/** users whose timezone is already in the past will receive the message immediately. */
+ | 'PAST_TIMEZONES_BEHAVIOUR_SEND_IMMEDIATELY'
+/** users whose timezone is already in the past will not receive the message. */
+ | 'PAST_TIMEZONES_BEHAVIOUR_DO_NOT_SEND'
+/** users whose timezone is already in the past will receive the message on the next day. */
+ | 'PAST_TIMEZONES_BEHAVIOUR_NEXT_DAY';
+export type Schedule_sendDate_at = {
+    type: 'at';
+    data: Date;
+};
+export type Schedule_sendDate_after = {
+    type: 'after';
+    data: Duration;
+};
+export type Schedule_sendDate = Schedule_sendDate_at | Schedule_sendDate_after;
+/** Message schedule. */
+export type Schedule = {
+    /** Whether to send the message according to user's timezone. */
+    followUserTimezone: boolean;
+    /** What to do with past timezones. */
+    pastTimezonesBehaviour: Schedule_PastTimezonesBehaviour;
+    sendDate: Schedule_sendDate;
+};
+/** Message frequency capping. */
+export type FrequencyCapping = {
+    days: number;
+    count: number;
+    exclude: boolean;
+    avoid: boolean;
+};
+export type SendRate = {
+    value: number;
+    bucket: string;
+    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 = {
+    event: string;
+    dismissalDate: number;
+    contentState: object;
+    staleDate: number;
+    relevanceScore: number;
+    attributesType: string;
+    attributes: object;
+    start: number;
+};
+export type Link_Shortener = 'NONE' | 'BITLY';
+export type Link = {
+    url: string;
+    shortener: Link_Shortener;
+};
+export type RichMedia_kind_code = {
+    type: 'code';
+    data: string;
+};
+export type RichMedia_kind_url = {
+    type: 'url';
+    data: string;
+};
+export type RichMedia_kind = RichMedia_kind_code | RichMedia_kind_url;
+export type RichMedia = {
+    kind: RichMedia_kind;
+};
+export type DeepLink = {
+    code: string;
+    params: Record<string, string>;
+};
+export type OpenAction_kind_richMedia = {
+    type: 'richMedia';
+    data: RichMedia;
+};
+export type OpenAction_kind_deepLink = {
+    type: 'deepLink';
+    data: DeepLink;
+};
+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: OpenAction_kind;
+};
+export type Inbox = {
+    imageUrl: string;
+    expirationDate: Date;
+};
+export type Content_GlobalProperties = {
+    timeToLive: Duration;
+};
+export type Content_PlatformPropertiesIos = {
+    title: string;
+    subtitle: string;
+    body: string;
+    timeToLive: Duration;
+    isCritical: boolean;
+    attachment: string;
+    sound: string;
+    threadId: string;
+    badges: string;
+    trimContent: boolean;
+    categoryId: string;
+    soundEnabled: boolean;
+    interruptionLevel: string;
+    rootParams: object;
+    liveActivity: LiveActivity;
+    collapseId: string;
+    inbox: Inbox;
+    liveActivityId: string;
+};
+export type Content_PlatformPropertiesAndroid = {
+    title: string;
+    body: string;
+    timeToLive: Duration;
+    icon: string;
+    banner: string;
+    deliveryPriority: DeliveryPriority;
+    vibration: boolean;
+    badges: string;
+    sound: string;
+    ledColor: string;
+    soundEnabled: boolean;
+    iconBackgroundColor: string;
+    showOnLockscreen: boolean;
+    rootParams: object;
+    customIcon: string;
+    priority: NotificationPriority;
+    groupId: string;
+    collapseKey: string;
+    inbox: Inbox;
+};
+export type Content_PlatformPropertiesChrome = {
+    title: string;
+    body: string;
+    timeToLive: Duration;
+    icon: string;
+    image: string;
+    rootParams: object;
+    duration: Duration;
+    buttonText1: string;
+    buttonUrl1: string;
+    buttonText2: string;
+    buttonUrl2: string;
+    inbox: Inbox;
+};
+export type Content_PlatformPropertiesFirefox = {
+    title: string;
+    body: string;
+    icon: string;
+    rootParams: object;
+    inbox: Inbox;
+};
+export type Content_PlatformPropertiesSafari = {
+    title: string;
+    body: string;
+    timeToLive: Duration;
+    action: string;
+    urlArguments: string[];
+    inbox: Inbox;
+};
+export type Content_PlatformPropertiesMacOS = {
+    title: string;
+    body: string;
+    timeToLive: Duration;
+    action: string;
+    sound: string;
+    soundEnabled: boolean;
+    badges: string;
+    rootParams: object;
+    inbox: Inbox;
+    subtitle: string;
+};
+export type Content_PlatformPropertiesAmazon = {
+    title: string;
+    body: string;
+    timeToLive: Duration;
+    banner: string;
+    sound: string;
+    soundEnabled: boolean;
+    rootParams: object;
+    icon: string;
+    customIcon: string;
+    priority: NotificationPriority;
+    inbox: Inbox;
+};
+export type Content_PlatformPropertiesBaiduAndroid = {
+    title: string;
+    body: string;
+    timeToLive: Duration;
+    icon: string;
+    banner: string;
+    deliveryPriority: DeliveryPriority;
+    vibration: boolean;
+    badges: string;
+    sound: string;
+    ledColor: string;
+    soundEnabled: boolean;
+    iconBackgroundColor: string;
+    showOnLockscreen: boolean;
+    rootParams: object;
+    customIcon: string;
+    priority: NotificationPriority;
+    groupId: string;
+    inbox: Inbox;
+};
+export type Content_PlatformPropertiesHuaweiAndroid = {
+    title: string;
+    body: string;
+    timeToLive: Duration;
+    icon: string;
+    banner: string;
+    deliveryPriority: DeliveryPriority;
+    vibration: boolean;
+    badges: string;
+    sound: string;
+    ledColor: string;
+    soundEnabled: boolean;
+    iconBackgroundColor: string;
+    showOnLockscreen: boolean;
+    rootParams: object;
+    customIcon: string;
+    priority: NotificationPriority;
+    groupId: string;
+    inbox: Inbox;
+};
+export type Content_PlatformPropertiesIE = {
+    title: string;
+    iconBadge: string;
+    body: string;
+    inbox: Inbox;
+};
+export type Content_PlatformPropertiesWindows_Raw = {
+    content: string;
+};
+export type Content_PlatformPropertiesWindows_Template = {
+    title: string;
+    subtitle: string;
+    body: string;
+    imageUrl: string;
+};
+export type Content_PlatformPropertiesWindows_Type = 'TILE' | 'TOAST' | 'BADGE';
+export type Content_PlatformPropertiesWindows_content_raw = {
+    type: 'raw';
+    data: Content_PlatformPropertiesWindows_Raw;
+};
+export type Content_PlatformPropertiesWindows_content_template = {
+    type: 'template';
+    data: Content_PlatformPropertiesWindows_Template;
+};
+export type Content_PlatformPropertiesWindows_content = Content_PlatformPropertiesWindows_content_raw | Content_PlatformPropertiesWindows_content_template;
+export type Content_PlatformPropertiesWindows = {
+    type: Content_PlatformPropertiesWindows_Type;
+    tag: string;
+    cache: boolean;
+    timeToLive: Duration;
+    content: Content_PlatformPropertiesWindows_content;
+};
+export type Content_PlatformPropertiesSMS = {
+    body: string;
+};
+export type Content_PlatformPropertiesTelegram = {
+    body: string;
+    contentVariables: string;
+};
+export type Content_PlatformPropertiesKakao = {
+    content: string;
+    template: string;
+    contentVariables: string;
+};
+export type Content_PlatformPropertiesLine = {
+    content: string;
+    template: string;
+};
+export type Content_PlatformPropertiesWhatsApp = {
+    /**
+     * Free-form text body. Meta only accepts it inside the 24-hour customer
+     * service window (opened when the end user sent an inbound message).
+     * Exactly one of `content` or `content_id` must be set.
+     */
+    content: string;
+    /**
+     * Name of a pre-approved Meta template (e.g. "hello_world"). Required for
+     * outbound initiation or any message outside the 24h window; dynamic data
+     * goes through {content,header,button_url}_variables.
+     * Exactly one of `content` or `content_id` must be set.
+     */
+    contentId: string;
+    /**
+     * Template locale that must exactly match the one approved in Meta
+     * (e.g. "en_US", "en_GB"). Only meaningful with `content_id`.
+     */
+    language: string;
+    /** 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://..."}).
+     */
+    buttonUrlVariables: string;
+    /**
+     * JSON string, map of header placeholders keyed by type
+     * (e.g. {"image":"https://..."}).
+     */
+    headerVariables: string;
+};
+export type Content = {
+    ios: Content_PlatformPropertiesIos;
+    android: Content_PlatformPropertiesAndroid;
+    macOs: Content_PlatformPropertiesMacOS;
+    amazon: Content_PlatformPropertiesAmazon;
+    safari: Content_PlatformPropertiesSafari;
+    chrome: Content_PlatformPropertiesChrome;
+    firefox: Content_PlatformPropertiesFirefox;
+    baiduAndroid: Content_PlatformPropertiesBaiduAndroid;
+    huaweiAndroid: Content_PlatformPropertiesHuaweiAndroid;
+    ie: Content_PlatformPropertiesIE;
+    windows: Content_PlatformPropertiesWindows;
+    telegram: Content_PlatformPropertiesTelegram;
+    kakao: Content_PlatformPropertiesKakao;
+    line: Content_PlatformPropertiesLine;
+    whatsapp: Content_PlatformPropertiesWhatsApp;
+    globalProperties: Content_GlobalProperties;
+    sms: Content_PlatformPropertiesSMS;
+};
+export type LocalizedContent = {
+    localizedContent: Record<string, Content>;
+};
+export type Payload_kind_content = {
+    type: 'content';
+    data: LocalizedContent;
+};
+export type Payload_kind_silent = {
+    type: 'silent';
+    data: boolean;
+};
+export type Payload_kind = Payload_kind_content | Payload_kind_silent;
+export type Payload = {
+    preset: string;
+    customData: object;
+    openAction: OpenAction;
+    openActions: Record<number, OpenAction>;
+    voipPush: boolean;
+    appleWalletPassUpdate: boolean;
+    appleWalletPassSerial: string;
+    kind: Payload_kind;
+};
+/** Email attachments. */
+export type EmailPayload_Attachment = {
+    /** File name of the attachment. */
+    name: string;
+    /** Base64-encoded content of the attachment file. */
+    content: string;
+};
+/** Email address descriptor (name and email). */
+export type EmailPayload_Address = {
+    name: string;
+    email: string;
+};
+export type EmailPayload = {
+    /** Subject line for the email. Per-locale values */
+    subject: Record<string, string>;
+    /** Email body HTML content. Use LocalizedContent to provide per-locale values. */
+    body: string;
+    attachments: EmailPayload_Attachment[];
+    /** Custom URL for the List-Unsubscribe header. */
+    listUnsubscribe: string;
+    /** Override default "From" configured in application properties. */
+    from: EmailPayload_Address;
+    /** Override default "Reply-To" configured in application properties. */
+    replyTo: EmailPayload_Address;
+    /** Email template code to use for this email, must reference an existing Email Template. */
+    emailTemplate: string;
+};

package/pushwoosh_channels_messagingApi_v2.js

@@ -0,0 +1,3 @@
+/* eslint-disable */
+/* Autogenerated code */
+export {};